From 5bf22fc7e3c392c8bd44315ca2d06d7dca7d084e Mon Sep 17 00:00:00 2001 From: sotech117 Date: Thu, 31 Jul 2025 17:27:24 -0400 Subject: add code for analysis of data --- .../site-packages/plotly/graph_objs/__init__.py | 305 + .../site-packages/plotly/graph_objs/_bar.py | 2598 ++ .../site-packages/plotly/graph_objs/_barpolar.py | 1606 ++ .../site-packages/plotly/graph_objs/_box.py | 3050 +++ .../plotly/graph_objs/_candlestick.py | 1677 ++ .../site-packages/plotly/graph_objs/_carpet.py | 1257 + .../site-packages/plotly/graph_objs/_choropleth.py | 1755 ++ .../plotly/graph_objs/_choroplethmap.py | 1749 ++ .../plotly/graph_objs/_choroplethmapbox.py | 1777 ++ .../site-packages/plotly/graph_objs/_cone.py | 2260 ++ .../site-packages/plotly/graph_objs/_contour.py | 2616 ++ .../plotly/graph_objs/_contourcarpet.py | 1837 ++ .../site-packages/plotly/graph_objs/_densitymap.py | 1722 ++ .../plotly/graph_objs/_densitymapbox.py | 1749 ++ .../plotly/graph_objs/_deprecations.py | 723 + .../site-packages/plotly/graph_objs/_figure.py | 24433 ++++++++++++++++++ .../plotly/graph_objs/_figurewidget.py | 24437 +++++++++++++++++++ .../site-packages/plotly/graph_objs/_frame.py | 220 + .../site-packages/plotly/graph_objs/_funnel.py | 2392 ++ .../site-packages/plotly/graph_objs/_funnelarea.py | 1640 ++ .../site-packages/plotly/graph_objs/_heatmap.py | 2531 ++ .../site-packages/plotly/graph_objs/_histogram.py | 2419 ++ .../plotly/graph_objs/_histogram2d.py | 2363 ++ .../plotly/graph_objs/_histogram2dcontour.py | 2422 ++ .../site-packages/plotly/graph_objs/_icicle.py | 1765 ++ .../site-packages/plotly/graph_objs/_image.py | 1454 ++ .../site-packages/plotly/graph_objs/_indicator.py | 848 + .../site-packages/plotly/graph_objs/_isosurface.py | 2161 ++ .../site-packages/plotly/graph_objs/_layout.py | 3507 +++ .../site-packages/plotly/graph_objs/_mesh3d.py | 2577 ++ .../site-packages/plotly/graph_objs/_ohlc.py | 1675 ++ .../site-packages/plotly/graph_objs/_parcats.py | 934 + .../site-packages/plotly/graph_objs/_parcoords.py | 919 + .../site-packages/plotly/graph_objs/_pie.py | 1869 ++ .../site-packages/plotly/graph_objs/_sankey.py | 966 + .../site-packages/plotly/graph_objs/_scatter.py | 2750 +++ .../site-packages/plotly/graph_objs/_scatter3d.py | 1995 ++ .../plotly/graph_objs/_scattercarpet.py | 1826 ++ .../site-packages/plotly/graph_objs/_scattergeo.py | 1854 ++ .../site-packages/plotly/graph_objs/_scattergl.py | 2287 ++ .../site-packages/plotly/graph_objs/_scattermap.py | 1708 ++ .../plotly/graph_objs/_scattermapbox.py | 1736 ++ .../plotly/graph_objs/_scatterpolar.py | 1913 ++ .../plotly/graph_objs/_scatterpolargl.py | 1874 ++ .../plotly/graph_objs/_scattersmith.py | 1779 ++ .../plotly/graph_objs/_scatterternary.py | 1889 ++ .../site-packages/plotly/graph_objs/_splom.py | 1520 ++ .../site-packages/plotly/graph_objs/_streamtube.py | 2166 ++ .../site-packages/plotly/graph_objs/_sunburst.py | 1760 ++ .../site-packages/plotly/graph_objs/_surface.py | 2138 ++ .../site-packages/plotly/graph_objs/_table.py | 908 + .../site-packages/plotly/graph_objs/_treemap.py | 1738 ++ .../site-packages/plotly/graph_objs/_violin.py | 2264 ++ .../site-packages/plotly/graph_objs/_volume.py | 2211 ++ .../site-packages/plotly/graph_objs/_waterfall.py | 2580 ++ .../plotly/graph_objs/bar/__init__.py | 40 + .../plotly/graph_objs/bar/_error_x.py | 502 + .../plotly/graph_objs/bar/_error_y.py | 479 + .../plotly/graph_objs/bar/_hoverlabel.py | 338 + .../plotly/graph_objs/bar/_insidetextfont.py | 587 + .../plotly/graph_objs/bar/_legendgrouptitle.py | 104 + .../site-packages/plotly/graph_objs/bar/_marker.py | 685 + .../plotly/graph_objs/bar/_outsidetextfont.py | 587 + .../plotly/graph_objs/bar/_selected.py | 105 + .../site-packages/plotly/graph_objs/bar/_stream.py | 113 + .../plotly/graph_objs/bar/_textfont.py | 586 + .../plotly/graph_objs/bar/_unselected.py | 106 + .../plotly/graph_objs/bar/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/bar/hoverlabel/_font.py | 587 + .../graph_objs/bar/legendgrouptitle/__init__.py | 9 + .../graph_objs/bar/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/bar/marker/__init__.py | 16 + .../plotly/graph_objs/bar/marker/_colorbar.py | 1721 ++ .../plotly/graph_objs/bar/marker/_line.py | 546 + .../plotly/graph_objs/bar/marker/_pattern.py | 433 + .../graph_objs/bar/marker/colorbar/__init__.py | 16 + .../graph_objs/bar/marker/colorbar/_tickfont.py | 334 + .../bar/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/bar/marker/colorbar/_title.py | 136 + .../bar/marker/colorbar/title/__init__.py | 9 + .../graph_objs/bar/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/bar/selected/__init__.py | 12 + .../plotly/graph_objs/bar/selected/_marker.py | 104 + .../plotly/graph_objs/bar/selected/_textfont.py | 81 + .../plotly/graph_objs/bar/unselected/__init__.py | 12 + .../plotly/graph_objs/bar/unselected/_marker.py | 110 + .../plotly/graph_objs/bar/unselected/_textfont.py | 84 + .../plotly/graph_objs/barpolar/__init__.py | 30 + .../plotly/graph_objs/barpolar/_hoverlabel.py | 338 + .../graph_objs/barpolar/_legendgrouptitle.py | 104 + .../plotly/graph_objs/barpolar/_marker.py | 650 + .../plotly/graph_objs/barpolar/_selected.py | 106 + .../plotly/graph_objs/barpolar/_stream.py | 114 + .../plotly/graph_objs/barpolar/_unselected.py | 106 + .../graph_objs/barpolar/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/barpolar/hoverlabel/_font.py | 587 + .../barpolar/legendgrouptitle/__init__.py | 9 + .../graph_objs/barpolar/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/barpolar/marker/__init__.py | 16 + .../plotly/graph_objs/barpolar/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/barpolar/marker/_line.py | 546 + .../plotly/graph_objs/barpolar/marker/_pattern.py | 433 + .../barpolar/marker/colorbar/__init__.py | 16 + .../barpolar/marker/colorbar/_tickfont.py | 334 + .../barpolar/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/barpolar/marker/colorbar/_title.py | 136 + .../barpolar/marker/colorbar/title/__init__.py | 9 + .../barpolar/marker/colorbar/title/_font.py | 334 + .../graph_objs/barpolar/selected/__init__.py | 12 + .../plotly/graph_objs/barpolar/selected/_marker.py | 104 + .../graph_objs/barpolar/selected/_textfont.py | 81 + .../graph_objs/barpolar/unselected/__init__.py | 12 + .../graph_objs/barpolar/unselected/_marker.py | 110 + .../graph_objs/barpolar/unselected/_textfont.py | 84 + .../plotly/graph_objs/box/__init__.py | 32 + .../plotly/graph_objs/box/_hoverlabel.py | 338 + .../plotly/graph_objs/box/_legendgrouptitle.py | 104 + .../site-packages/plotly/graph_objs/box/_line.py | 103 + .../site-packages/plotly/graph_objs/box/_marker.py | 357 + .../plotly/graph_objs/box/_selected.py | 79 + .../site-packages/plotly/graph_objs/box/_stream.py | 113 + .../plotly/graph_objs/box/_unselected.py | 80 + .../plotly/graph_objs/box/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/box/hoverlabel/_font.py | 587 + .../graph_objs/box/legendgrouptitle/__init__.py | 9 + .../graph_objs/box/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/box/marker/__init__.py | 9 + .../plotly/graph_objs/box/marker/_line.py | 181 + .../plotly/graph_objs/box/selected/__init__.py | 9 + .../plotly/graph_objs/box/selected/_marker.py | 127 + .../plotly/graph_objs/box/unselected/__init__.py | 9 + .../plotly/graph_objs/box/unselected/_marker.py | 136 + .../plotly/graph_objs/candlestick/__init__.py | 29 + .../plotly/graph_objs/candlestick/_decreasing.py | 113 + .../plotly/graph_objs/candlestick/_hoverlabel.py | 366 + .../plotly/graph_objs/candlestick/_increasing.py | 113 + .../graph_objs/candlestick/_legendgrouptitle.py | 104 + .../plotly/graph_objs/candlestick/_line.py | 85 + .../plotly/graph_objs/candlestick/_stream.py | 114 + .../graph_objs/candlestick/decreasing/__init__.py | 9 + .../graph_objs/candlestick/decreasing/_line.py | 104 + .../graph_objs/candlestick/hoverlabel/__init__.py | 9 + .../graph_objs/candlestick/hoverlabel/_font.py | 587 + .../graph_objs/candlestick/increasing/__init__.py | 9 + .../graph_objs/candlestick/increasing/_line.py | 104 + .../candlestick/legendgrouptitle/__init__.py | 9 + .../candlestick/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/carpet/__init__.py | 26 + .../plotly/graph_objs/carpet/_aaxis.py | 1850 ++ .../plotly/graph_objs/carpet/_baxis.py | 1850 ++ .../plotly/graph_objs/carpet/_font.py | 333 + .../plotly/graph_objs/carpet/_legendgrouptitle.py | 104 + .../plotly/graph_objs/carpet/_stream.py | 113 + .../plotly/graph_objs/carpet/aaxis/__init__.py | 16 + .../plotly/graph_objs/carpet/aaxis/_tickfont.py | 334 + .../graph_objs/carpet/aaxis/_tickformatstop.py | 241 + .../plotly/graph_objs/carpet/aaxis/_title.py | 130 + .../graph_objs/carpet/aaxis/title/__init__.py | 9 + .../plotly/graph_objs/carpet/aaxis/title/_font.py | 334 + .../plotly/graph_objs/carpet/baxis/__init__.py | 16 + .../plotly/graph_objs/carpet/baxis/_tickfont.py | 334 + .../graph_objs/carpet/baxis/_tickformatstop.py | 241 + .../plotly/graph_objs/carpet/baxis/_title.py | 130 + .../graph_objs/carpet/baxis/title/__init__.py | 9 + .../plotly/graph_objs/carpet/baxis/title/_font.py | 334 + .../graph_objs/carpet/legendgrouptitle/__init__.py | 9 + .../graph_objs/carpet/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/choropleth/__init__.py | 40 + .../plotly/graph_objs/choropleth/_colorbar.py | 1721 ++ .../plotly/graph_objs/choropleth/_hoverlabel.py | 338 + .../graph_objs/choropleth/_legendgrouptitle.py | 104 + .../plotly/graph_objs/choropleth/_marker.py | 129 + .../plotly/graph_objs/choropleth/_selected.py | 80 + .../plotly/graph_objs/choropleth/_stream.py | 114 + .../plotly/graph_objs/choropleth/_unselected.py | 80 + .../graph_objs/choropleth/colorbar/__init__.py | 16 + .../graph_objs/choropleth/colorbar/_tickfont.py | 334 + .../choropleth/colorbar/_tickformatstop.py | 241 + .../graph_objs/choropleth/colorbar/_title.py | 136 + .../choropleth/colorbar/title/__init__.py | 9 + .../graph_objs/choropleth/colorbar/title/_font.py | 334 + .../graph_objs/choropleth/hoverlabel/__init__.py | 9 + .../graph_objs/choropleth/hoverlabel/_font.py | 587 + .../choropleth/legendgrouptitle/__init__.py | 9 + .../choropleth/legendgrouptitle/_font.py | 334 + .../graph_objs/choropleth/marker/__init__.py | 9 + .../plotly/graph_objs/choropleth/marker/_line.py | 171 + .../graph_objs/choropleth/selected/__init__.py | 9 + .../graph_objs/choropleth/selected/_marker.py | 77 + .../graph_objs/choropleth/unselected/__init__.py | 9 + .../graph_objs/choropleth/unselected/_marker.py | 80 + .../plotly/graph_objs/choroplethmap/__init__.py | 40 + .../plotly/graph_objs/choroplethmap/_colorbar.py | 1722 ++ .../plotly/graph_objs/choroplethmap/_hoverlabel.py | 338 + .../graph_objs/choroplethmap/_legendgrouptitle.py | 104 + .../plotly/graph_objs/choroplethmap/_marker.py | 129 + .../plotly/graph_objs/choroplethmap/_selected.py | 80 + .../plotly/graph_objs/choroplethmap/_stream.py | 114 + .../plotly/graph_objs/choroplethmap/_unselected.py | 80 + .../graph_objs/choroplethmap/colorbar/__init__.py | 16 + .../graph_objs/choroplethmap/colorbar/_tickfont.py | 334 + .../choroplethmap/colorbar/_tickformatstop.py | 241 + .../graph_objs/choroplethmap/colorbar/_title.py | 136 + .../choroplethmap/colorbar/title/__init__.py | 9 + .../choroplethmap/colorbar/title/_font.py | 334 + .../choroplethmap/hoverlabel/__init__.py | 9 + .../graph_objs/choroplethmap/hoverlabel/_font.py | 587 + .../choroplethmap/legendgrouptitle/__init__.py | 9 + .../choroplethmap/legendgrouptitle/_font.py | 334 + .../graph_objs/choroplethmap/marker/__init__.py | 9 + .../graph_objs/choroplethmap/marker/_line.py | 171 + .../graph_objs/choroplethmap/selected/__init__.py | 9 + .../graph_objs/choroplethmap/selected/_marker.py | 77 + .../choroplethmap/unselected/__init__.py | 9 + .../graph_objs/choroplethmap/unselected/_marker.py | 80 + .../plotly/graph_objs/choroplethmapbox/__init__.py | 40 + .../graph_objs/choroplethmapbox/_colorbar.py | 1722 ++ .../graph_objs/choroplethmapbox/_hoverlabel.py | 338 + .../choroplethmapbox/_legendgrouptitle.py | 104 + .../plotly/graph_objs/choroplethmapbox/_marker.py | 129 + .../graph_objs/choroplethmapbox/_selected.py | 80 + .../plotly/graph_objs/choroplethmapbox/_stream.py | 114 + .../graph_objs/choroplethmapbox/_unselected.py | 80 + .../choroplethmapbox/colorbar/__init__.py | 16 + .../choroplethmapbox/colorbar/_tickfont.py | 334 + .../choroplethmapbox/colorbar/_tickformatstop.py | 241 + .../graph_objs/choroplethmapbox/colorbar/_title.py | 136 + .../choroplethmapbox/colorbar/title/__init__.py | 9 + .../choroplethmapbox/colorbar/title/_font.py | 334 + .../choroplethmapbox/hoverlabel/__init__.py | 9 + .../choroplethmapbox/hoverlabel/_font.py | 587 + .../choroplethmapbox/legendgrouptitle/__init__.py | 9 + .../choroplethmapbox/legendgrouptitle/_font.py | 334 + .../graph_objs/choroplethmapbox/marker/__init__.py | 9 + .../graph_objs/choroplethmapbox/marker/_line.py | 171 + .../choroplethmapbox/selected/__init__.py | 9 + .../choroplethmapbox/selected/_marker.py | 77 + .../choroplethmapbox/unselected/__init__.py | 9 + .../choroplethmapbox/unselected/_marker.py | 80 + .../plotly/graph_objs/cone/__init__.py | 28 + .../plotly/graph_objs/cone/_colorbar.py | 1721 ++ .../plotly/graph_objs/cone/_hoverlabel.py | 338 + .../plotly/graph_objs/cone/_legendgrouptitle.py | 104 + .../plotly/graph_objs/cone/_lighting.py | 259 + .../plotly/graph_objs/cone/_lightposition.py | 129 + .../plotly/graph_objs/cone/_stream.py | 113 + .../plotly/graph_objs/cone/colorbar/__init__.py | 16 + .../plotly/graph_objs/cone/colorbar/_tickfont.py | 334 + .../graph_objs/cone/colorbar/_tickformatstop.py | 241 + .../plotly/graph_objs/cone/colorbar/_title.py | 136 + .../graph_objs/cone/colorbar/title/__init__.py | 9 + .../plotly/graph_objs/cone/colorbar/title/_font.py | 334 + .../plotly/graph_objs/cone/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/cone/hoverlabel/_font.py | 587 + .../graph_objs/cone/legendgrouptitle/__init__.py | 9 + .../graph_objs/cone/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/contour/__init__.py | 31 + .../plotly/graph_objs/contour/_colorbar.py | 1722 ++ .../plotly/graph_objs/contour/_contours.py | 436 + .../plotly/graph_objs/contour/_hoverlabel.py | 338 + .../plotly/graph_objs/contour/_legendgrouptitle.py | 104 + .../plotly/graph_objs/contour/_line.py | 175 + .../plotly/graph_objs/contour/_stream.py | 114 + .../plotly/graph_objs/contour/_textfont.py | 335 + .../plotly/graph_objs/contour/colorbar/__init__.py | 16 + .../graph_objs/contour/colorbar/_tickfont.py | 334 + .../graph_objs/contour/colorbar/_tickformatstop.py | 241 + .../plotly/graph_objs/contour/colorbar/_title.py | 136 + .../graph_objs/contour/colorbar/title/__init__.py | 9 + .../graph_objs/contour/colorbar/title/_font.py | 334 + .../plotly/graph_objs/contour/contours/__init__.py | 11 + .../graph_objs/contour/contours/_labelfont.py | 336 + .../graph_objs/contour/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/contour/hoverlabel/_font.py | 587 + .../contour/legendgrouptitle/__init__.py | 9 + .../graph_objs/contour/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/contourcarpet/__init__.py | 26 + .../plotly/graph_objs/contourcarpet/_colorbar.py | 1722 ++ .../plotly/graph_objs/contourcarpet/_contours.py | 433 + .../graph_objs/contourcarpet/_legendgrouptitle.py | 104 + .../plotly/graph_objs/contourcarpet/_line.py | 176 + .../plotly/graph_objs/contourcarpet/_stream.py | 114 + .../graph_objs/contourcarpet/colorbar/__init__.py | 16 + .../graph_objs/contourcarpet/colorbar/_tickfont.py | 334 + .../contourcarpet/colorbar/_tickformatstop.py | 241 + .../graph_objs/contourcarpet/colorbar/_title.py | 136 + .../contourcarpet/colorbar/title/__init__.py | 9 + .../contourcarpet/colorbar/title/_font.py | 334 + .../graph_objs/contourcarpet/contours/__init__.py | 11 + .../contourcarpet/contours/_labelfont.py | 336 + .../contourcarpet/legendgrouptitle/__init__.py | 9 + .../contourcarpet/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/densitymap/__init__.py | 24 + .../plotly/graph_objs/densitymap/_colorbar.py | 1721 ++ .../plotly/graph_objs/densitymap/_hoverlabel.py | 338 + .../graph_objs/densitymap/_legendgrouptitle.py | 104 + .../plotly/graph_objs/densitymap/_stream.py | 114 + .../graph_objs/densitymap/colorbar/__init__.py | 16 + .../graph_objs/densitymap/colorbar/_tickfont.py | 334 + .../densitymap/colorbar/_tickformatstop.py | 241 + .../graph_objs/densitymap/colorbar/_title.py | 136 + .../densitymap/colorbar/title/__init__.py | 9 + .../graph_objs/densitymap/colorbar/title/_font.py | 334 + .../graph_objs/densitymap/hoverlabel/__init__.py | 9 + .../graph_objs/densitymap/hoverlabel/_font.py | 587 + .../densitymap/legendgrouptitle/__init__.py | 9 + .../densitymap/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/densitymapbox/__init__.py | 24 + .../plotly/graph_objs/densitymapbox/_colorbar.py | 1722 ++ .../plotly/graph_objs/densitymapbox/_hoverlabel.py | 338 + .../graph_objs/densitymapbox/_legendgrouptitle.py | 104 + .../plotly/graph_objs/densitymapbox/_stream.py | 114 + .../graph_objs/densitymapbox/colorbar/__init__.py | 16 + .../graph_objs/densitymapbox/colorbar/_tickfont.py | 334 + .../densitymapbox/colorbar/_tickformatstop.py | 241 + .../graph_objs/densitymapbox/colorbar/_title.py | 136 + .../densitymapbox/colorbar/title/__init__.py | 9 + .../densitymapbox/colorbar/title/_font.py | 334 + .../densitymapbox/hoverlabel/__init__.py | 9 + .../graph_objs/densitymapbox/hoverlabel/_font.py | 587 + .../densitymapbox/legendgrouptitle/__init__.py | 9 + .../densitymapbox/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/funnel/__init__.py | 33 + .../plotly/graph_objs/funnel/_connector.py | 130 + .../plotly/graph_objs/funnel/_hoverlabel.py | 338 + .../plotly/graph_objs/funnel/_insidetextfont.py | 587 + .../plotly/graph_objs/funnel/_legendgrouptitle.py | 104 + .../plotly/graph_objs/funnel/_marker.py | 621 + .../plotly/graph_objs/funnel/_outsidetextfont.py | 587 + .../plotly/graph_objs/funnel/_stream.py | 113 + .../plotly/graph_objs/funnel/_textfont.py | 587 + .../plotly/graph_objs/funnel/connector/__init__.py | 9 + .../plotly/graph_objs/funnel/connector/_line.py | 139 + .../graph_objs/funnel/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/funnel/hoverlabel/_font.py | 587 + .../graph_objs/funnel/legendgrouptitle/__init__.py | 9 + .../graph_objs/funnel/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/funnel/marker/__init__.py | 13 + .../plotly/graph_objs/funnel/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/funnel/marker/_line.py | 546 + .../graph_objs/funnel/marker/colorbar/__init__.py | 16 + .../graph_objs/funnel/marker/colorbar/_tickfont.py | 334 + .../funnel/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/funnel/marker/colorbar/_title.py | 136 + .../funnel/marker/colorbar/title/__init__.py | 9 + .../funnel/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/funnelarea/__init__.py | 33 + .../plotly/graph_objs/funnelarea/_domain.py | 170 + .../plotly/graph_objs/funnelarea/_hoverlabel.py | 338 + .../graph_objs/funnelarea/_insidetextfont.py | 587 + .../graph_objs/funnelarea/_legendgrouptitle.py | 104 + .../plotly/graph_objs/funnelarea/_marker.py | 161 + .../plotly/graph_objs/funnelarea/_stream.py | 114 + .../plotly/graph_objs/funnelarea/_textfont.py | 587 + .../plotly/graph_objs/funnelarea/_title.py | 131 + .../graph_objs/funnelarea/hoverlabel/__init__.py | 9 + .../graph_objs/funnelarea/hoverlabel/_font.py | 587 + .../funnelarea/legendgrouptitle/__init__.py | 9 + .../funnelarea/legendgrouptitle/_font.py | 334 + .../graph_objs/funnelarea/marker/__init__.py | 12 + .../plotly/graph_objs/funnelarea/marker/_line.py | 163 + .../graph_objs/funnelarea/marker/_pattern.py | 433 + .../plotly/graph_objs/funnelarea/title/__init__.py | 9 + .../plotly/graph_objs/funnelarea/title/_font.py | 587 + .../site-packages/plotly/graph_objs/graph_objs.py | 1 + .../plotly/graph_objs/heatmap/__init__.py | 26 + .../plotly/graph_objs/heatmap/_colorbar.py | 1722 ++ .../plotly/graph_objs/heatmap/_hoverlabel.py | 338 + .../plotly/graph_objs/heatmap/_legendgrouptitle.py | 104 + .../plotly/graph_objs/heatmap/_stream.py | 114 + .../plotly/graph_objs/heatmap/_textfont.py | 334 + .../plotly/graph_objs/heatmap/colorbar/__init__.py | 16 + .../graph_objs/heatmap/colorbar/_tickfont.py | 334 + .../graph_objs/heatmap/colorbar/_tickformatstop.py | 241 + .../plotly/graph_objs/heatmap/colorbar/_title.py | 136 + .../graph_objs/heatmap/colorbar/title/__init__.py | 9 + .../graph_objs/heatmap/colorbar/title/_font.py | 334 + .../graph_objs/heatmap/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/heatmap/hoverlabel/_font.py | 587 + .../heatmap/legendgrouptitle/__init__.py | 9 + .../graph_objs/heatmap/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/histogram/__init__.py | 46 + .../plotly/graph_objs/histogram/_cumulative.py | 173 + .../plotly/graph_objs/histogram/_error_x.py | 503 + .../plotly/graph_objs/histogram/_error_y.py | 480 + .../plotly/graph_objs/histogram/_hoverlabel.py | 338 + .../plotly/graph_objs/histogram/_insidetextfont.py | 334 + .../graph_objs/histogram/_legendgrouptitle.py | 104 + .../plotly/graph_objs/histogram/_marker.py | 686 + .../graph_objs/histogram/_outsidetextfont.py | 334 + .../plotly/graph_objs/histogram/_selected.py | 106 + .../plotly/graph_objs/histogram/_stream.py | 114 + .../plotly/graph_objs/histogram/_textfont.py | 334 + .../plotly/graph_objs/histogram/_unselected.py | 106 + .../plotly/graph_objs/histogram/_xbins.py | 210 + .../plotly/graph_objs/histogram/_ybins.py | 210 + .../graph_objs/histogram/hoverlabel/__init__.py | 9 + .../graph_objs/histogram/hoverlabel/_font.py | 587 + .../histogram/legendgrouptitle/__init__.py | 9 + .../graph_objs/histogram/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/histogram/marker/__init__.py | 16 + .../graph_objs/histogram/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/histogram/marker/_line.py | 546 + .../plotly/graph_objs/histogram/marker/_pattern.py | 433 + .../histogram/marker/colorbar/__init__.py | 16 + .../histogram/marker/colorbar/_tickfont.py | 334 + .../histogram/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/histogram/marker/colorbar/_title.py | 136 + .../histogram/marker/colorbar/title/__init__.py | 9 + .../histogram/marker/colorbar/title/_font.py | 334 + .../graph_objs/histogram/selected/__init__.py | 12 + .../graph_objs/histogram/selected/_marker.py | 104 + .../graph_objs/histogram/selected/_textfont.py | 81 + .../graph_objs/histogram/unselected/__init__.py | 12 + .../graph_objs/histogram/unselected/_marker.py | 110 + .../graph_objs/histogram/unselected/_textfont.py | 84 + .../plotly/graph_objs/histogram2d/__init__.py | 32 + .../plotly/graph_objs/histogram2d/_colorbar.py | 1722 ++ .../plotly/graph_objs/histogram2d/_hoverlabel.py | 338 + .../graph_objs/histogram2d/_legendgrouptitle.py | 104 + .../plotly/graph_objs/histogram2d/_marker.py | 102 + .../plotly/graph_objs/histogram2d/_stream.py | 114 + .../plotly/graph_objs/histogram2d/_textfont.py | 334 + .../plotly/graph_objs/histogram2d/_xbins.py | 187 + .../plotly/graph_objs/histogram2d/_ybins.py | 187 + .../graph_objs/histogram2d/colorbar/__init__.py | 16 + .../graph_objs/histogram2d/colorbar/_tickfont.py | 334 + .../histogram2d/colorbar/_tickformatstop.py | 241 + .../graph_objs/histogram2d/colorbar/_title.py | 136 + .../histogram2d/colorbar/title/__init__.py | 9 + .../graph_objs/histogram2d/colorbar/title/_font.py | 334 + .../graph_objs/histogram2d/hoverlabel/__init__.py | 9 + .../graph_objs/histogram2d/hoverlabel/_font.py | 587 + .../histogram2d/legendgrouptitle/__init__.py | 9 + .../histogram2d/legendgrouptitle/_font.py | 334 + .../graph_objs/histogram2dcontour/__init__.py | 37 + .../graph_objs/histogram2dcontour/_colorbar.py | 1722 ++ .../graph_objs/histogram2dcontour/_contours.py | 436 + .../graph_objs/histogram2dcontour/_hoverlabel.py | 338 + .../histogram2dcontour/_legendgrouptitle.py | 104 + .../plotly/graph_objs/histogram2dcontour/_line.py | 170 + .../graph_objs/histogram2dcontour/_marker.py | 102 + .../graph_objs/histogram2dcontour/_stream.py | 114 + .../graph_objs/histogram2dcontour/_textfont.py | 335 + .../plotly/graph_objs/histogram2dcontour/_xbins.py | 187 + .../plotly/graph_objs/histogram2dcontour/_ybins.py | 187 + .../histogram2dcontour/colorbar/__init__.py | 16 + .../histogram2dcontour/colorbar/_tickfont.py | 334 + .../histogram2dcontour/colorbar/_tickformatstop.py | 241 + .../histogram2dcontour/colorbar/_title.py | 136 + .../histogram2dcontour/colorbar/title/__init__.py | 9 + .../histogram2dcontour/colorbar/title/_font.py | 334 + .../histogram2dcontour/contours/__init__.py | 11 + .../histogram2dcontour/contours/_labelfont.py | 336 + .../histogram2dcontour/hoverlabel/__init__.py | 9 + .../histogram2dcontour/hoverlabel/_font.py | 587 + .../legendgrouptitle/__init__.py | 9 + .../histogram2dcontour/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/icicle/__init__.py | 41 + .../plotly/graph_objs/icicle/_domain.py | 169 + .../plotly/graph_objs/icicle/_hoverlabel.py | 338 + .../plotly/graph_objs/icicle/_insidetextfont.py | 587 + .../plotly/graph_objs/icicle/_leaf.py | 79 + .../plotly/graph_objs/icicle/_legendgrouptitle.py | 104 + .../plotly/graph_objs/icicle/_marker.py | 578 + .../plotly/graph_objs/icicle/_outsidetextfont.py | 591 + .../plotly/graph_objs/icicle/_pathbar.py | 198 + .../plotly/graph_objs/icicle/_root.py | 86 + .../plotly/graph_objs/icicle/_stream.py | 113 + .../plotly/graph_objs/icicle/_textfont.py | 587 + .../plotly/graph_objs/icicle/_tiling.py | 153 + .../graph_objs/icicle/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/icicle/hoverlabel/_font.py | 587 + .../graph_objs/icicle/legendgrouptitle/__init__.py | 9 + .../graph_objs/icicle/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/icicle/marker/__init__.py | 16 + .../plotly/graph_objs/icicle/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/icicle/marker/_line.py | 163 + .../plotly/graph_objs/icicle/marker/_pattern.py | 433 + .../graph_objs/icicle/marker/colorbar/__init__.py | 16 + .../graph_objs/icicle/marker/colorbar/_tickfont.py | 334 + .../icicle/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/icicle/marker/colorbar/_title.py | 136 + .../icicle/marker/colorbar/title/__init__.py | 9 + .../icicle/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/icicle/pathbar/__init__.py | 11 + .../plotly/graph_objs/icicle/pathbar/_textfont.py | 587 + .../plotly/graph_objs/image/__init__.py | 21 + .../plotly/graph_objs/image/_hoverlabel.py | 338 + .../plotly/graph_objs/image/_legendgrouptitle.py | 104 + .../plotly/graph_objs/image/_stream.py | 113 + .../plotly/graph_objs/image/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/image/hoverlabel/_font.py | 587 + .../graph_objs/image/legendgrouptitle/__init__.py | 9 + .../graph_objs/image/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/indicator/__init__.py | 32 + .../plotly/graph_objs/indicator/_delta.py | 309 + .../plotly/graph_objs/indicator/_domain.py | 170 + .../plotly/graph_objs/indicator/_gauge.py | 323 + .../graph_objs/indicator/_legendgrouptitle.py | 104 + .../plotly/graph_objs/indicator/_number.py | 163 + .../plotly/graph_objs/indicator/_stream.py | 114 + .../plotly/graph_objs/indicator/_title.py | 134 + .../plotly/graph_objs/indicator/delta/__init__.py | 15 + .../graph_objs/indicator/delta/_decreasing.py | 105 + .../plotly/graph_objs/indicator/delta/_font.py | 334 + .../graph_objs/indicator/delta/_increasing.py | 105 + .../plotly/graph_objs/indicator/gauge/__init__.py | 20 + .../plotly/graph_objs/indicator/gauge/_axis.py | 1108 + .../plotly/graph_objs/indicator/gauge/_bar.py | 135 + .../plotly/graph_objs/indicator/gauge/_step.py | 262 + .../graph_objs/indicator/gauge/_threshold.py | 129 + .../graph_objs/indicator/gauge/axis/__init__.py | 12 + .../graph_objs/indicator/gauge/axis/_tickfont.py | 334 + .../indicator/gauge/axis/_tickformatstop.py | 241 + .../graph_objs/indicator/gauge/bar/__init__.py | 9 + .../plotly/graph_objs/indicator/gauge/bar/_line.py | 106 + .../graph_objs/indicator/gauge/step/__init__.py | 9 + .../graph_objs/indicator/gauge/step/_line.py | 106 + .../indicator/gauge/threshold/__init__.py | 9 + .../graph_objs/indicator/gauge/threshold/_line.py | 104 + .../indicator/legendgrouptitle/__init__.py | 9 + .../graph_objs/indicator/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/indicator/number/__init__.py | 9 + .../plotly/graph_objs/indicator/number/_font.py | 334 + .../plotly/graph_objs/indicator/title/__init__.py | 9 + .../plotly/graph_objs/indicator/title/_font.py | 334 + .../plotly/graph_objs/isosurface/__init__.py | 40 + .../plotly/graph_objs/isosurface/_caps.py | 132 + .../plotly/graph_objs/isosurface/_colorbar.py | 1721 ++ .../plotly/graph_objs/isosurface/_contour.py | 127 + .../plotly/graph_objs/isosurface/_hoverlabel.py | 338 + .../graph_objs/isosurface/_legendgrouptitle.py | 104 + .../plotly/graph_objs/isosurface/_lighting.py | 260 + .../plotly/graph_objs/isosurface/_lightposition.py | 129 + .../plotly/graph_objs/isosurface/_slices.py | 132 + .../plotly/graph_objs/isosurface/_spaceframe.py | 122 + .../plotly/graph_objs/isosurface/_stream.py | 114 + .../plotly/graph_objs/isosurface/_surface.py | 193 + .../plotly/graph_objs/isosurface/caps/__init__.py | 13 + .../plotly/graph_objs/isosurface/caps/_x.py | 122 + .../plotly/graph_objs/isosurface/caps/_y.py | 122 + .../plotly/graph_objs/isosurface/caps/_z.py | 122 + .../graph_objs/isosurface/colorbar/__init__.py | 16 + .../graph_objs/isosurface/colorbar/_tickfont.py | 334 + .../isosurface/colorbar/_tickformatstop.py | 241 + .../graph_objs/isosurface/colorbar/_title.py | 136 + .../isosurface/colorbar/title/__init__.py | 9 + .../graph_objs/isosurface/colorbar/title/_font.py | 334 + .../graph_objs/isosurface/hoverlabel/__init__.py | 9 + .../graph_objs/isosurface/hoverlabel/_font.py | 587 + .../isosurface/legendgrouptitle/__init__.py | 9 + .../isosurface/legendgrouptitle/_font.py | 334 + .../graph_objs/isosurface/slices/__init__.py | 13 + .../plotly/graph_objs/isosurface/slices/_x.py | 177 + .../plotly/graph_objs/isosurface/slices/_y.py | 177 + .../plotly/graph_objs/isosurface/slices/_z.py | 177 + .../plotly/graph_objs/layout/__init__.py | 120 + .../plotly/graph_objs/layout/_activeselection.py | 104 + .../plotly/graph_objs/layout/_activeshape.py | 104 + .../plotly/graph_objs/layout/_annotation.py | 1714 ++ .../plotly/graph_objs/layout/_coloraxis.py | 396 + .../plotly/graph_objs/layout/_colorscale.py | 214 + .../plotly/graph_objs/layout/_font.py | 334 + .../site-packages/plotly/graph_objs/layout/_geo.py | 968 + .../plotly/graph_objs/layout/_grid.py | 511 + .../plotly/graph_objs/layout/_hoverlabel.py | 254 + .../plotly/graph_objs/layout/_image.py | 608 + .../plotly/graph_objs/layout/_legend.py | 916 + .../site-packages/plotly/graph_objs/layout/_map.py | 392 + .../plotly/graph_objs/layout/_mapbox.py | 452 + .../plotly/graph_objs/layout/_margin.py | 212 + .../plotly/graph_objs/layout/_modebar.py | 387 + .../plotly/graph_objs/layout/_newselection.py | 118 + .../plotly/graph_objs/layout/_newshape.py | 543 + .../plotly/graph_objs/layout/_polar.py | 382 + .../plotly/graph_objs/layout/_scene.py | 454 + .../plotly/graph_objs/layout/_selection.py | 493 + .../plotly/graph_objs/layout/_shape.py | 1287 + .../plotly/graph_objs/layout/_slider.py | 786 + .../plotly/graph_objs/layout/_smith.py | 166 + .../plotly/graph_objs/layout/_template.py | 133 + .../plotly/graph_objs/layout/_ternary.py | 250 + .../plotly/graph_objs/layout/_title.py | 450 + .../plotly/graph_objs/layout/_transition.py | 144 + .../plotly/graph_objs/layout/_uniformtext.py | 124 + .../plotly/graph_objs/layout/_updatemenu.py | 632 + .../plotly/graph_objs/layout/_xaxis.py | 3415 +++ .../plotly/graph_objs/layout/_yaxis.py | 3443 +++ .../graph_objs/layout/annotation/__init__.py | 13 + .../plotly/graph_objs/layout/annotation/_font.py | 334 + .../graph_objs/layout/annotation/_hoverlabel.py | 151 + .../layout/annotation/hoverlabel/__init__.py | 9 + .../layout/annotation/hoverlabel/_font.py | 335 + .../plotly/graph_objs/layout/coloraxis/__init__.py | 12 + .../graph_objs/layout/coloraxis/_colorbar.py | 1722 ++ .../layout/coloraxis/colorbar/__init__.py | 16 + .../layout/coloraxis/colorbar/_tickfont.py | 334 + .../layout/coloraxis/colorbar/_tickformatstop.py | 241 + .../graph_objs/layout/coloraxis/colorbar/_title.py | 136 + .../layout/coloraxis/colorbar/title/__init__.py | 9 + .../layout/coloraxis/colorbar/title/_font.py | 334 + .../plotly/graph_objs/layout/geo/__init__.py | 24 + .../plotly/graph_objs/layout/geo/_center.py | 115 + .../plotly/graph_objs/layout/geo/_domain.py | 204 + .../plotly/graph_objs/layout/geo/_lataxis.py | 258 + .../plotly/graph_objs/layout/geo/_lonaxis.py | 258 + .../plotly/graph_objs/layout/geo/_projection.py | 251 + .../graph_objs/layout/geo/projection/__init__.py | 11 + .../graph_objs/layout/geo/projection/_rotation.py | 129 + .../plotly/graph_objs/layout/grid/__init__.py | 9 + .../plotly/graph_objs/layout/grid/_domain.py | 122 + .../graph_objs/layout/hoverlabel/__init__.py | 12 + .../plotly/graph_objs/layout/hoverlabel/_font.py | 335 + .../layout/hoverlabel/_grouptitlefont.py | 335 + .../plotly/graph_objs/layout/legend/__init__.py | 16 + .../plotly/graph_objs/layout/legend/_font.py | 334 + .../graph_objs/layout/legend/_grouptitlefont.py | 335 + .../plotly/graph_objs/layout/legend/_title.py | 145 + .../graph_objs/layout/legend/title/__init__.py | 9 + .../plotly/graph_objs/layout/legend/title/_font.py | 335 + .../plotly/graph_objs/layout/map/__init__.py | 17 + .../plotly/graph_objs/layout/map/_bounds.py | 160 + .../plotly/graph_objs/layout/map/_center.py | 104 + .../plotly/graph_objs/layout/map/_domain.py | 170 + .../plotly/graph_objs/layout/map/_layer.py | 691 + .../plotly/graph_objs/layout/map/layer/__init__.py | 17 + .../plotly/graph_objs/layout/map/layer/_circle.py | 80 + .../plotly/graph_objs/layout/map/layer/_fill.py | 86 + .../plotly/graph_objs/layout/map/layer/_line.py | 133 + .../plotly/graph_objs/layout/map/layer/_symbol.py | 243 + .../graph_objs/layout/map/layer/symbol/__init__.py | 11 + .../layout/map/layer/symbol/_textfont.py | 202 + .../plotly/graph_objs/layout/mapbox/__init__.py | 17 + .../plotly/graph_objs/layout/mapbox/_bounds.py | 160 + .../plotly/graph_objs/layout/mapbox/_center.py | 104 + .../plotly/graph_objs/layout/mapbox/_domain.py | 170 + .../plotly/graph_objs/layout/mapbox/_layer.py | 695 + .../graph_objs/layout/mapbox/layer/__init__.py | 17 + .../graph_objs/layout/mapbox/layer/_circle.py | 82 + .../plotly/graph_objs/layout/mapbox/layer/_fill.py | 86 + .../plotly/graph_objs/layout/mapbox/layer/_line.py | 133 + .../graph_objs/layout/mapbox/layer/_symbol.py | 245 + .../layout/mapbox/layer/symbol/__init__.py | 11 + .../layout/mapbox/layer/symbol/_textfont.py | 202 + .../graph_objs/layout/newselection/__init__.py | 9 + .../plotly/graph_objs/layout/newselection/_line.py | 142 + .../plotly/graph_objs/layout/newshape/__init__.py | 17 + .../plotly/graph_objs/layout/newshape/_label.py | 397 + .../layout/newshape/_legendgrouptitle.py | 104 + .../plotly/graph_objs/layout/newshape/_line.py | 142 + .../graph_objs/layout/newshape/label/__init__.py | 9 + .../graph_objs/layout/newshape/label/_font.py | 334 + .../layout/newshape/legendgrouptitle/__init__.py | 9 + .../layout/newshape/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/layout/polar/__init__.py | 17 + .../plotly/graph_objs/layout/polar/_angularaxis.py | 1776 ++ .../plotly/graph_objs/layout/polar/_domain.py | 170 + .../plotly/graph_objs/layout/polar/_radialaxis.py | 2049 ++ .../layout/polar/angularaxis/__init__.py | 12 + .../layout/polar/angularaxis/_tickfont.py | 334 + .../layout/polar/angularaxis/_tickformatstop.py | 241 + .../graph_objs/layout/polar/radialaxis/__init__.py | 22 + .../layout/polar/radialaxis/_autorangeoptions.py | 216 + .../layout/polar/radialaxis/_tickfont.py | 334 + .../layout/polar/radialaxis/_tickformatstop.py | 241 + .../graph_objs/layout/polar/radialaxis/_title.py | 104 + .../layout/polar/radialaxis/title/__init__.py | 9 + .../layout/polar/radialaxis/title/_font.py | 334 + .../plotly/graph_objs/layout/scene/__init__.py | 32 + .../plotly/graph_objs/layout/scene/_annotation.py | 1243 + .../plotly/graph_objs/layout/scene/_aspectratio.py | 119 + .../plotly/graph_objs/layout/scene/_camera.py | 183 + .../plotly/graph_objs/layout/scene/_domain.py | 170 + .../plotly/graph_objs/layout/scene/_xaxis.py | 2111 ++ .../plotly/graph_objs/layout/scene/_yaxis.py | 2111 ++ .../plotly/graph_objs/layout/scene/_zaxis.py | 2111 ++ .../graph_objs/layout/scene/annotation/__init__.py | 13 + .../graph_objs/layout/scene/annotation/_font.py | 334 + .../layout/scene/annotation/_hoverlabel.py | 151 + .../layout/scene/annotation/hoverlabel/__init__.py | 9 + .../layout/scene/annotation/hoverlabel/_font.py | 335 + .../graph_objs/layout/scene/camera/__init__.py | 16 + .../graph_objs/layout/scene/camera/_center.py | 121 + .../plotly/graph_objs/layout/scene/camera/_eye.py | 121 + .../graph_objs/layout/scene/camera/_projection.py | 83 + .../plotly/graph_objs/layout/scene/camera/_up.py | 122 + .../graph_objs/layout/scene/xaxis/__init__.py | 22 + .../layout/scene/xaxis/_autorangeoptions.py | 216 + .../graph_objs/layout/scene/xaxis/_tickfont.py | 334 + .../layout/scene/xaxis/_tickformatstop.py | 241 + .../plotly/graph_objs/layout/scene/xaxis/_title.py | 104 + .../layout/scene/xaxis/title/__init__.py | 9 + .../graph_objs/layout/scene/xaxis/title/_font.py | 334 + .../graph_objs/layout/scene/yaxis/__init__.py | 22 + .../layout/scene/yaxis/_autorangeoptions.py | 216 + .../graph_objs/layout/scene/yaxis/_tickfont.py | 334 + .../layout/scene/yaxis/_tickformatstop.py | 241 + .../plotly/graph_objs/layout/scene/yaxis/_title.py | 104 + .../layout/scene/yaxis/title/__init__.py | 9 + .../graph_objs/layout/scene/yaxis/title/_font.py | 334 + .../graph_objs/layout/scene/zaxis/__init__.py | 22 + .../layout/scene/zaxis/_autorangeoptions.py | 216 + .../graph_objs/layout/scene/zaxis/_tickfont.py | 334 + .../layout/scene/zaxis/_tickformatstop.py | 241 + .../plotly/graph_objs/layout/scene/zaxis/_title.py | 104 + .../layout/scene/zaxis/title/__init__.py | 9 + .../graph_objs/layout/scene/zaxis/title/_font.py | 334 + .../plotly/graph_objs/layout/selection/__init__.py | 9 + .../plotly/graph_objs/layout/selection/_line.py | 139 + .../plotly/graph_objs/layout/shape/__init__.py | 17 + .../plotly/graph_objs/layout/shape/_label.py | 396 + .../graph_objs/layout/shape/_legendgrouptitle.py | 104 + .../plotly/graph_objs/layout/shape/_line.py | 139 + .../graph_objs/layout/shape/label/__init__.py | 9 + .../plotly/graph_objs/layout/shape/label/_font.py | 334 + .../layout/shape/legendgrouptitle/__init__.py | 9 + .../layout/shape/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/layout/slider/__init__.py | 24 + .../graph_objs/layout/slider/_currentvalue.py | 220 + .../plotly/graph_objs/layout/slider/_font.py | 334 + .../plotly/graph_objs/layout/slider/_pad.py | 159 + .../plotly/graph_objs/layout/slider/_step.py | 354 + .../plotly/graph_objs/layout/slider/_transition.py | 109 + .../layout/slider/currentvalue/__init__.py | 9 + .../graph_objs/layout/slider/currentvalue/_font.py | 334 + .../plotly/graph_objs/layout/smith/__init__.py | 17 + .../plotly/graph_objs/layout/smith/_domain.py | 170 + .../graph_objs/layout/smith/_imaginaryaxis.py | 865 + .../plotly/graph_objs/layout/smith/_realaxis.py | 922 + .../layout/smith/imaginaryaxis/__init__.py | 11 + .../layout/smith/imaginaryaxis/_tickfont.py | 334 + .../graph_objs/layout/smith/realaxis/__init__.py | 11 + .../graph_objs/layout/smith/realaxis/_tickfont.py | 334 + .../plotly/graph_objs/layout/template/__init__.py | 13 + .../plotly/graph_objs/layout/template/_data.py | 1435 ++ .../plotly/graph_objs/layout/template/_layout.py | 1 + .../graph_objs/layout/template/data/__init__.py | 111 + .../plotly/graph_objs/layout/template/data/_bar.py | 1 + .../graph_objs/layout/template/data/_barpolar.py | 1 + .../plotly/graph_objs/layout/template/data/_box.py | 1 + .../layout/template/data/_candlestick.py | 1 + .../graph_objs/layout/template/data/_carpet.py | 1 + .../graph_objs/layout/template/data/_choropleth.py | 1 + .../layout/template/data/_choroplethmap.py | 1 + .../layout/template/data/_choroplethmapbox.py | 1 + .../graph_objs/layout/template/data/_cone.py | 1 + .../graph_objs/layout/template/data/_contour.py | 1 + .../layout/template/data/_contourcarpet.py | 1 + .../graph_objs/layout/template/data/_densitymap.py | 1 + .../layout/template/data/_densitymapbox.py | 1 + .../graph_objs/layout/template/data/_funnel.py | 1 + .../graph_objs/layout/template/data/_funnelarea.py | 1 + .../graph_objs/layout/template/data/_heatmap.py | 1 + .../graph_objs/layout/template/data/_histogram.py | 1 + .../layout/template/data/_histogram2d.py | 1 + .../layout/template/data/_histogram2dcontour.py | 1 + .../graph_objs/layout/template/data/_icicle.py | 1 + .../graph_objs/layout/template/data/_image.py | 1 + .../graph_objs/layout/template/data/_indicator.py | 1 + .../graph_objs/layout/template/data/_isosurface.py | 1 + .../graph_objs/layout/template/data/_mesh3d.py | 1 + .../graph_objs/layout/template/data/_ohlc.py | 1 + .../graph_objs/layout/template/data/_parcats.py | 1 + .../graph_objs/layout/template/data/_parcoords.py | 1 + .../plotly/graph_objs/layout/template/data/_pie.py | 1 + .../graph_objs/layout/template/data/_sankey.py | 1 + .../graph_objs/layout/template/data/_scatter.py | 1 + .../graph_objs/layout/template/data/_scatter3d.py | 1 + .../layout/template/data/_scattercarpet.py | 1 + .../graph_objs/layout/template/data/_scattergeo.py | 1 + .../graph_objs/layout/template/data/_scattergl.py | 1 + .../graph_objs/layout/template/data/_scattermap.py | 1 + .../layout/template/data/_scattermapbox.py | 1 + .../layout/template/data/_scatterpolar.py | 1 + .../layout/template/data/_scatterpolargl.py | 1 + .../layout/template/data/_scattersmith.py | 1 + .../layout/template/data/_scatterternary.py | 1 + .../graph_objs/layout/template/data/_splom.py | 1 + .../graph_objs/layout/template/data/_streamtube.py | 1 + .../graph_objs/layout/template/data/_sunburst.py | 1 + .../graph_objs/layout/template/data/_surface.py | 1 + .../graph_objs/layout/template/data/_table.py | 1 + .../graph_objs/layout/template/data/_treemap.py | 1 + .../graph_objs/layout/template/data/_violin.py | 1 + .../graph_objs/layout/template/data/_volume.py | 1 + .../graph_objs/layout/template/data/_waterfall.py | 1 + .../plotly/graph_objs/layout/ternary/__init__.py | 19 + .../plotly/graph_objs/layout/ternary/_aaxis.py | 1474 ++ .../plotly/graph_objs/layout/ternary/_baxis.py | 1474 ++ .../plotly/graph_objs/layout/ternary/_caxis.py | 1474 ++ .../plotly/graph_objs/layout/ternary/_domain.py | 170 + .../graph_objs/layout/ternary/aaxis/__init__.py | 16 + .../graph_objs/layout/ternary/aaxis/_tickfont.py | 334 + .../layout/ternary/aaxis/_tickformatstop.py | 241 + .../graph_objs/layout/ternary/aaxis/_title.py | 104 + .../layout/ternary/aaxis/title/__init__.py | 9 + .../graph_objs/layout/ternary/aaxis/title/_font.py | 334 + .../graph_objs/layout/ternary/baxis/__init__.py | 16 + .../graph_objs/layout/ternary/baxis/_tickfont.py | 334 + .../layout/ternary/baxis/_tickformatstop.py | 241 + .../graph_objs/layout/ternary/baxis/_title.py | 104 + .../layout/ternary/baxis/title/__init__.py | 9 + .../graph_objs/layout/ternary/baxis/title/_font.py | 334 + .../graph_objs/layout/ternary/caxis/__init__.py | 16 + .../graph_objs/layout/ternary/caxis/_tickfont.py | 334 + .../layout/ternary/caxis/_tickformatstop.py | 241 + .../graph_objs/layout/ternary/caxis/_title.py | 104 + .../layout/ternary/caxis/title/__init__.py | 9 + .../graph_objs/layout/ternary/caxis/title/_font.py | 334 + .../plotly/graph_objs/layout/title/__init__.py | 14 + .../plotly/graph_objs/layout/title/_font.py | 334 + .../plotly/graph_objs/layout/title/_pad.py | 164 + .../plotly/graph_objs/layout/title/_subtitle.py | 104 + .../graph_objs/layout/title/subtitle/__init__.py | 9 + .../graph_objs/layout/title/subtitle/_font.py | 334 + .../graph_objs/layout/updatemenu/__init__.py | 13 + .../plotly/graph_objs/layout/updatemenu/_button.py | 359 + .../plotly/graph_objs/layout/updatemenu/_font.py | 334 + .../plotly/graph_objs/layout/updatemenu/_pad.py | 159 + .../plotly/graph_objs/layout/xaxis/__init__.py | 32 + .../graph_objs/layout/xaxis/_autorangeoptions.py | 216 + .../plotly/graph_objs/layout/xaxis/_minor.py | 566 + .../plotly/graph_objs/layout/xaxis/_rangebreak.py | 330 + .../graph_objs/layout/xaxis/_rangeselector.py | 427 + .../plotly/graph_objs/layout/xaxis/_rangeslider.py | 311 + .../plotly/graph_objs/layout/xaxis/_tickfont.py | 334 + .../graph_objs/layout/xaxis/_tickformatstop.py | 241 + .../plotly/graph_objs/layout/xaxis/_title.py | 150 + .../layout/xaxis/rangeselector/__init__.py | 12 + .../layout/xaxis/rangeselector/_button.py | 318 + .../graph_objs/layout/xaxis/rangeselector/_font.py | 334 + .../layout/xaxis/rangeslider/__init__.py | 9 + .../graph_objs/layout/xaxis/rangeslider/_yaxis.py | 118 + .../graph_objs/layout/xaxis/title/__init__.py | 9 + .../plotly/graph_objs/layout/xaxis/title/_font.py | 334 + .../plotly/graph_objs/layout/yaxis/__init__.py | 26 + .../graph_objs/layout/yaxis/_autorangeoptions.py | 216 + .../plotly/graph_objs/layout/yaxis/_minor.py | 566 + .../plotly/graph_objs/layout/yaxis/_rangebreak.py | 330 + .../plotly/graph_objs/layout/yaxis/_tickfont.py | 334 + .../graph_objs/layout/yaxis/_tickformatstop.py | 241 + .../plotly/graph_objs/layout/yaxis/_title.py | 150 + .../graph_objs/layout/yaxis/title/__init__.py | 9 + .../plotly/graph_objs/layout/yaxis/title/_font.py | 334 + .../plotly/graph_objs/mesh3d/__init__.py | 30 + .../plotly/graph_objs/mesh3d/_colorbar.py | 1722 ++ .../plotly/graph_objs/mesh3d/_contour.py | 127 + .../plotly/graph_objs/mesh3d/_hoverlabel.py | 338 + .../plotly/graph_objs/mesh3d/_legendgrouptitle.py | 104 + .../plotly/graph_objs/mesh3d/_lighting.py | 260 + .../plotly/graph_objs/mesh3d/_lightposition.py | 129 + .../plotly/graph_objs/mesh3d/_stream.py | 113 + .../plotly/graph_objs/mesh3d/colorbar/__init__.py | 16 + .../plotly/graph_objs/mesh3d/colorbar/_tickfont.py | 334 + .../graph_objs/mesh3d/colorbar/_tickformatstop.py | 241 + .../plotly/graph_objs/mesh3d/colorbar/_title.py | 136 + .../graph_objs/mesh3d/colorbar/title/__init__.py | 9 + .../graph_objs/mesh3d/colorbar/title/_font.py | 334 + .../graph_objs/mesh3d/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/mesh3d/hoverlabel/_font.py | 587 + .../graph_objs/mesh3d/legendgrouptitle/__init__.py | 9 + .../graph_objs/mesh3d/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/ohlc/__init__.py | 29 + .../plotly/graph_objs/ohlc/_decreasing.py | 80 + .../plotly/graph_objs/ohlc/_hoverlabel.py | 366 + .../plotly/graph_objs/ohlc/_increasing.py | 80 + .../plotly/graph_objs/ohlc/_legendgrouptitle.py | 104 + .../site-packages/plotly/graph_objs/ohlc/_line.py | 123 + .../plotly/graph_objs/ohlc/_stream.py | 113 + .../plotly/graph_objs/ohlc/decreasing/__init__.py | 9 + .../plotly/graph_objs/ohlc/decreasing/_line.py | 139 + .../plotly/graph_objs/ohlc/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/ohlc/hoverlabel/_font.py | 587 + .../plotly/graph_objs/ohlc/increasing/__init__.py | 9 + .../plotly/graph_objs/ohlc/increasing/_line.py | 139 + .../graph_objs/ohlc/legendgrouptitle/__init__.py | 9 + .../graph_objs/ohlc/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/parcats/__init__.py | 29 + .../plotly/graph_objs/parcats/_dimension.py | 383 + .../plotly/graph_objs/parcats/_domain.py | 170 + .../plotly/graph_objs/parcats/_labelfont.py | 334 + .../plotly/graph_objs/parcats/_legendgrouptitle.py | 104 + .../plotly/graph_objs/parcats/_line.py | 680 + .../plotly/graph_objs/parcats/_stream.py | 114 + .../plotly/graph_objs/parcats/_tickfont.py | 334 + .../parcats/legendgrouptitle/__init__.py | 9 + .../graph_objs/parcats/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/parcats/line/__init__.py | 12 + .../plotly/graph_objs/parcats/line/_colorbar.py | 1722 ++ .../graph_objs/parcats/line/colorbar/__init__.py | 16 + .../graph_objs/parcats/line/colorbar/_tickfont.py | 334 + .../parcats/line/colorbar/_tickformatstop.py | 241 + .../graph_objs/parcats/line/colorbar/_title.py | 136 + .../parcats/line/colorbar/title/__init__.py | 9 + .../parcats/line/colorbar/title/_font.py | 334 + .../plotly/graph_objs/parcoords/__init__.py | 34 + .../plotly/graph_objs/parcoords/_dimension.py | 546 + .../plotly/graph_objs/parcoords/_domain.py | 170 + .../plotly/graph_objs/parcoords/_labelfont.py | 334 + .../graph_objs/parcoords/_legendgrouptitle.py | 104 + .../plotly/graph_objs/parcoords/_line.py | 540 + .../plotly/graph_objs/parcoords/_rangefont.py | 334 + .../plotly/graph_objs/parcoords/_stream.py | 114 + .../plotly/graph_objs/parcoords/_tickfont.py | 334 + .../plotly/graph_objs/parcoords/_unselected.py | 80 + .../parcoords/legendgrouptitle/__init__.py | 9 + .../graph_objs/parcoords/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/parcoords/line/__init__.py | 12 + .../plotly/graph_objs/parcoords/line/_colorbar.py | 1722 ++ .../graph_objs/parcoords/line/colorbar/__init__.py | 16 + .../parcoords/line/colorbar/_tickfont.py | 334 + .../parcoords/line/colorbar/_tickformatstop.py | 241 + .../graph_objs/parcoords/line/colorbar/_title.py | 136 + .../parcoords/line/colorbar/title/__init__.py | 9 + .../parcoords/line/colorbar/title/_font.py | 334 + .../graph_objs/parcoords/unselected/__init__.py | 9 + .../graph_objs/parcoords/unselected/_line.py | 115 + .../plotly/graph_objs/pie/__init__.py | 35 + .../site-packages/plotly/graph_objs/pie/_domain.py | 168 + .../plotly/graph_objs/pie/_hoverlabel.py | 338 + .../plotly/graph_objs/pie/_insidetextfont.py | 587 + .../plotly/graph_objs/pie/_legendgrouptitle.py | 104 + .../site-packages/plotly/graph_objs/pie/_marker.py | 160 + .../plotly/graph_objs/pie/_outsidetextfont.py | 587 + .../site-packages/plotly/graph_objs/pie/_stream.py | 113 + .../plotly/graph_objs/pie/_textfont.py | 586 + .../site-packages/plotly/graph_objs/pie/_title.py | 131 + .../plotly/graph_objs/pie/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/pie/hoverlabel/_font.py | 587 + .../graph_objs/pie/legendgrouptitle/__init__.py | 9 + .../graph_objs/pie/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/pie/marker/__init__.py | 12 + .../plotly/graph_objs/pie/marker/_line.py | 160 + .../plotly/graph_objs/pie/marker/_pattern.py | 433 + .../plotly/graph_objs/pie/title/__init__.py | 9 + .../plotly/graph_objs/pie/title/_font.py | 587 + .../plotly/graph_objs/sankey/__init__.py | 31 + .../plotly/graph_objs/sankey/_domain.py | 169 + .../plotly/graph_objs/sankey/_hoverlabel.py | 338 + .../plotly/graph_objs/sankey/_legendgrouptitle.py | 104 + .../plotly/graph_objs/sankey/_link.py | 784 + .../plotly/graph_objs/sankey/_node.py | 682 + .../plotly/graph_objs/sankey/_stream.py | 113 + .../plotly/graph_objs/sankey/_textfont.py | 334 + .../graph_objs/sankey/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/sankey/hoverlabel/_font.py | 587 + .../graph_objs/sankey/legendgrouptitle/__init__.py | 9 + .../graph_objs/sankey/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/sankey/link/__init__.py | 16 + .../plotly/graph_objs/sankey/link/_colorscale.py | 304 + .../plotly/graph_objs/sankey/link/_hoverlabel.py | 338 + .../plotly/graph_objs/sankey/link/_line.py | 160 + .../graph_objs/sankey/link/hoverlabel/__init__.py | 9 + .../graph_objs/sankey/link/hoverlabel/_font.py | 587 + .../plotly/graph_objs/sankey/node/__init__.py | 13 + .../plotly/graph_objs/sankey/node/_hoverlabel.py | 338 + .../plotly/graph_objs/sankey/node/_line.py | 160 + .../graph_objs/sankey/node/hoverlabel/__init__.py | 9 + .../graph_objs/sankey/node/hoverlabel/_font.py | 587 + .../plotly/graph_objs/scatter/__init__.py | 42 + .../plotly/graph_objs/scatter/_error_x.py | 503 + .../plotly/graph_objs/scatter/_error_y.py | 480 + .../plotly/graph_objs/scatter/_fillgradient.py | 227 + .../plotly/graph_objs/scatter/_fillpattern.py | 433 + .../plotly/graph_objs/scatter/_hoverlabel.py | 338 + .../plotly/graph_objs/scatter/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scatter/_line.py | 310 + .../plotly/graph_objs/scatter/_marker.py | 1130 + .../plotly/graph_objs/scatter/_selected.py | 106 + .../plotly/graph_objs/scatter/_stream.py | 114 + .../plotly/graph_objs/scatter/_textfont.py | 587 + .../plotly/graph_objs/scatter/_unselected.py | 106 + .../graph_objs/scatter/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/scatter/hoverlabel/_font.py | 587 + .../scatter/legendgrouptitle/__init__.py | 9 + .../graph_objs/scatter/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/scatter/marker/__init__.py | 16 + .../plotly/graph_objs/scatter/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/scatter/marker/_gradient.py | 164 + .../plotly/graph_objs/scatter/marker/_line.py | 546 + .../graph_objs/scatter/marker/colorbar/__init__.py | 16 + .../scatter/marker/colorbar/_tickfont.py | 334 + .../scatter/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/scatter/marker/colorbar/_title.py | 136 + .../scatter/marker/colorbar/title/__init__.py | 9 + .../scatter/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/scatter/selected/__init__.py | 12 + .../plotly/graph_objs/scatter/selected/_marker.py | 127 + .../graph_objs/scatter/selected/_textfont.py | 81 + .../graph_objs/scatter/unselected/__init__.py | 12 + .../graph_objs/scatter/unselected/_marker.py | 136 + .../graph_objs/scatter/unselected/_textfont.py | 84 + .../plotly/graph_objs/scatter3d/__init__.py | 38 + .../plotly/graph_objs/scatter3d/_error_x.py | 503 + .../plotly/graph_objs/scatter3d/_error_y.py | 503 + .../plotly/graph_objs/scatter3d/_error_z.py | 480 + .../plotly/graph_objs/scatter3d/_hoverlabel.py | 338 + .../graph_objs/scatter3d/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scatter3d/_line.py | 592 + .../plotly/graph_objs/scatter3d/_marker.py | 810 + .../plotly/graph_objs/scatter3d/_projection.py | 132 + .../plotly/graph_objs/scatter3d/_stream.py | 114 + .../plotly/graph_objs/scatter3d/_textfont.py | 400 + .../graph_objs/scatter3d/hoverlabel/__init__.py | 9 + .../graph_objs/scatter3d/hoverlabel/_font.py | 587 + .../scatter3d/legendgrouptitle/__init__.py | 9 + .../graph_objs/scatter3d/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/scatter3d/line/__init__.py | 12 + .../plotly/graph_objs/scatter3d/line/_colorbar.py | 1722 ++ .../graph_objs/scatter3d/line/colorbar/__init__.py | 16 + .../scatter3d/line/colorbar/_tickfont.py | 334 + .../scatter3d/line/colorbar/_tickformatstop.py | 241 + .../graph_objs/scatter3d/line/colorbar/_title.py | 136 + .../scatter3d/line/colorbar/title/__init__.py | 9 + .../scatter3d/line/colorbar/title/_font.py | 334 + .../plotly/graph_objs/scatter3d/marker/__init__.py | 13 + .../graph_objs/scatter3d/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/scatter3d/marker/_line.py | 518 + .../scatter3d/marker/colorbar/__init__.py | 16 + .../scatter3d/marker/colorbar/_tickfont.py | 334 + .../scatter3d/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/scatter3d/marker/colorbar/_title.py | 136 + .../scatter3d/marker/colorbar/title/__init__.py | 9 + .../scatter3d/marker/colorbar/title/_font.py | 334 + .../graph_objs/scatter3d/projection/__init__.py | 13 + .../plotly/graph_objs/scatter3d/projection/_x.py | 128 + .../plotly/graph_objs/scatter3d/projection/_y.py | 128 + .../plotly/graph_objs/scatter3d/projection/_z.py | 128 + .../plotly/graph_objs/scattercarpet/__init__.py | 34 + .../plotly/graph_objs/scattercarpet/_hoverlabel.py | 338 + .../graph_objs/scattercarpet/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scattercarpet/_line.py | 277 + .../plotly/graph_objs/scattercarpet/_marker.py | 1130 + .../plotly/graph_objs/scattercarpet/_selected.py | 106 + .../plotly/graph_objs/scattercarpet/_stream.py | 114 + .../plotly/graph_objs/scattercarpet/_textfont.py | 587 + .../plotly/graph_objs/scattercarpet/_unselected.py | 106 + .../scattercarpet/hoverlabel/__init__.py | 9 + .../graph_objs/scattercarpet/hoverlabel/_font.py | 587 + .../scattercarpet/legendgrouptitle/__init__.py | 9 + .../scattercarpet/legendgrouptitle/_font.py | 334 + .../graph_objs/scattercarpet/marker/__init__.py | 16 + .../graph_objs/scattercarpet/marker/_colorbar.py | 1722 ++ .../graph_objs/scattercarpet/marker/_gradient.py | 164 + .../graph_objs/scattercarpet/marker/_line.py | 546 + .../scattercarpet/marker/colorbar/__init__.py | 16 + .../scattercarpet/marker/colorbar/_tickfont.py | 334 + .../marker/colorbar/_tickformatstop.py | 241 + .../scattercarpet/marker/colorbar/_title.py | 136 + .../marker/colorbar/title/__init__.py | 9 + .../scattercarpet/marker/colorbar/title/_font.py | 334 + .../graph_objs/scattercarpet/selected/__init__.py | 12 + .../graph_objs/scattercarpet/selected/_marker.py | 127 + .../graph_objs/scattercarpet/selected/_textfont.py | 81 + .../scattercarpet/unselected/__init__.py | 12 + .../graph_objs/scattercarpet/unselected/_marker.py | 136 + .../scattercarpet/unselected/_textfont.py | 84 + .../plotly/graph_objs/scattergeo/__init__.py | 34 + .../plotly/graph_objs/scattergeo/_hoverlabel.py | 338 + .../graph_objs/scattergeo/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scattergeo/_line.py | 139 + .../plotly/graph_objs/scattergeo/_marker.py | 1106 + .../plotly/graph_objs/scattergeo/_selected.py | 106 + .../plotly/graph_objs/scattergeo/_stream.py | 114 + .../plotly/graph_objs/scattergeo/_textfont.py | 587 + .../plotly/graph_objs/scattergeo/_unselected.py | 106 + .../graph_objs/scattergeo/hoverlabel/__init__.py | 9 + .../graph_objs/scattergeo/hoverlabel/_font.py | 587 + .../scattergeo/legendgrouptitle/__init__.py | 9 + .../scattergeo/legendgrouptitle/_font.py | 334 + .../graph_objs/scattergeo/marker/__init__.py | 16 + .../graph_objs/scattergeo/marker/_colorbar.py | 1722 ++ .../graph_objs/scattergeo/marker/_gradient.py | 164 + .../plotly/graph_objs/scattergeo/marker/_line.py | 546 + .../scattergeo/marker/colorbar/__init__.py | 16 + .../scattergeo/marker/colorbar/_tickfont.py | 334 + .../scattergeo/marker/colorbar/_tickformatstop.py | 241 + .../scattergeo/marker/colorbar/_title.py | 136 + .../scattergeo/marker/colorbar/title/__init__.py | 9 + .../scattergeo/marker/colorbar/title/_font.py | 334 + .../graph_objs/scattergeo/selected/__init__.py | 12 + .../graph_objs/scattergeo/selected/_marker.py | 127 + .../graph_objs/scattergeo/selected/_textfont.py | 81 + .../graph_objs/scattergeo/unselected/__init__.py | 12 + .../graph_objs/scattergeo/unselected/_marker.py | 136 + .../graph_objs/scattergeo/unselected/_textfont.py | 84 + .../plotly/graph_objs/scattergl/__init__.py | 38 + .../plotly/graph_objs/scattergl/_error_x.py | 503 + .../plotly/graph_objs/scattergl/_error_y.py | 480 + .../plotly/graph_objs/scattergl/_hoverlabel.py | 338 + .../graph_objs/scattergl/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scattergl/_line.py | 158 + .../plotly/graph_objs/scattergl/_marker.py | 978 + .../plotly/graph_objs/scattergl/_selected.py | 106 + .../plotly/graph_objs/scattergl/_stream.py | 114 + .../plotly/graph_objs/scattergl/_textfont.py | 399 + .../plotly/graph_objs/scattergl/_unselected.py | 106 + .../graph_objs/scattergl/hoverlabel/__init__.py | 9 + .../graph_objs/scattergl/hoverlabel/_font.py | 587 + .../scattergl/legendgrouptitle/__init__.py | 9 + .../graph_objs/scattergl/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/scattergl/marker/__init__.py | 13 + .../graph_objs/scattergl/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/scattergl/marker/_line.py | 546 + .../scattergl/marker/colorbar/__init__.py | 16 + .../scattergl/marker/colorbar/_tickfont.py | 334 + .../scattergl/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/scattergl/marker/colorbar/_title.py | 136 + .../scattergl/marker/colorbar/title/__init__.py | 9 + .../scattergl/marker/colorbar/title/_font.py | 334 + .../graph_objs/scattergl/selected/__init__.py | 12 + .../graph_objs/scattergl/selected/_marker.py | 127 + .../graph_objs/scattergl/selected/_textfont.py | 81 + .../graph_objs/scattergl/unselected/__init__.py | 12 + .../graph_objs/scattergl/unselected/_marker.py | 136 + .../graph_objs/scattergl/unselected/_textfont.py | 84 + .../plotly/graph_objs/scattermap/__init__.py | 36 + .../plotly/graph_objs/scattermap/_cluster.py | 342 + .../plotly/graph_objs/scattermap/_hoverlabel.py | 338 + .../graph_objs/scattermap/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scattermap/_line.py | 104 + .../plotly/graph_objs/scattermap/_marker.py | 892 + .../plotly/graph_objs/scattermap/_selected.py | 80 + .../plotly/graph_objs/scattermap/_stream.py | 114 + .../plotly/graph_objs/scattermap/_textfont.py | 202 + .../plotly/graph_objs/scattermap/_unselected.py | 80 + .../graph_objs/scattermap/hoverlabel/__init__.py | 9 + .../graph_objs/scattermap/hoverlabel/_font.py | 587 + .../scattermap/legendgrouptitle/__init__.py | 9 + .../scattermap/legendgrouptitle/_font.py | 334 + .../graph_objs/scattermap/marker/__init__.py | 12 + .../graph_objs/scattermap/marker/_colorbar.py | 1722 ++ .../scattermap/marker/colorbar/__init__.py | 16 + .../scattermap/marker/colorbar/_tickfont.py | 334 + .../scattermap/marker/colorbar/_tickformatstop.py | 241 + .../scattermap/marker/colorbar/_title.py | 136 + .../scattermap/marker/colorbar/title/__init__.py | 9 + .../scattermap/marker/colorbar/title/_font.py | 334 + .../graph_objs/scattermap/selected/__init__.py | 9 + .../graph_objs/scattermap/selected/_marker.py | 127 + .../graph_objs/scattermap/unselected/__init__.py | 9 + .../graph_objs/scattermap/unselected/_marker.py | 136 + .../plotly/graph_objs/scattermapbox/__init__.py | 36 + .../plotly/graph_objs/scattermapbox/_cluster.py | 342 + .../plotly/graph_objs/scattermapbox/_hoverlabel.py | 338 + .../graph_objs/scattermapbox/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scattermapbox/_line.py | 104 + .../plotly/graph_objs/scattermapbox/_marker.py | 892 + .../plotly/graph_objs/scattermapbox/_selected.py | 80 + .../plotly/graph_objs/scattermapbox/_stream.py | 114 + .../plotly/graph_objs/scattermapbox/_textfont.py | 202 + .../plotly/graph_objs/scattermapbox/_unselected.py | 80 + .../scattermapbox/hoverlabel/__init__.py | 9 + .../graph_objs/scattermapbox/hoverlabel/_font.py | 587 + .../scattermapbox/legendgrouptitle/__init__.py | 9 + .../scattermapbox/legendgrouptitle/_font.py | 334 + .../graph_objs/scattermapbox/marker/__init__.py | 12 + .../graph_objs/scattermapbox/marker/_colorbar.py | 1722 ++ .../scattermapbox/marker/colorbar/__init__.py | 16 + .../scattermapbox/marker/colorbar/_tickfont.py | 334 + .../marker/colorbar/_tickformatstop.py | 241 + .../scattermapbox/marker/colorbar/_title.py | 136 + .../marker/colorbar/title/__init__.py | 9 + .../scattermapbox/marker/colorbar/title/_font.py | 334 + .../graph_objs/scattermapbox/selected/__init__.py | 9 + .../graph_objs/scattermapbox/selected/_marker.py | 127 + .../scattermapbox/unselected/__init__.py | 9 + .../graph_objs/scattermapbox/unselected/_marker.py | 136 + .../plotly/graph_objs/scatterpolar/__init__.py | 34 + .../plotly/graph_objs/scatterpolar/_hoverlabel.py | 338 + .../graph_objs/scatterpolar/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scatterpolar/_line.py | 277 + .../plotly/graph_objs/scatterpolar/_marker.py | 1130 + .../plotly/graph_objs/scatterpolar/_selected.py | 106 + .../plotly/graph_objs/scatterpolar/_stream.py | 114 + .../plotly/graph_objs/scatterpolar/_textfont.py | 587 + .../plotly/graph_objs/scatterpolar/_unselected.py | 106 + .../graph_objs/scatterpolar/hoverlabel/__init__.py | 9 + .../graph_objs/scatterpolar/hoverlabel/_font.py | 587 + .../scatterpolar/legendgrouptitle/__init__.py | 9 + .../scatterpolar/legendgrouptitle/_font.py | 334 + .../graph_objs/scatterpolar/marker/__init__.py | 16 + .../graph_objs/scatterpolar/marker/_colorbar.py | 1722 ++ .../graph_objs/scatterpolar/marker/_gradient.py | 164 + .../plotly/graph_objs/scatterpolar/marker/_line.py | 546 + .../scatterpolar/marker/colorbar/__init__.py | 16 + .../scatterpolar/marker/colorbar/_tickfont.py | 334 + .../marker/colorbar/_tickformatstop.py | 241 + .../scatterpolar/marker/colorbar/_title.py | 136 + .../scatterpolar/marker/colorbar/title/__init__.py | 9 + .../scatterpolar/marker/colorbar/title/_font.py | 334 + .../graph_objs/scatterpolar/selected/__init__.py | 12 + .../graph_objs/scatterpolar/selected/_marker.py | 127 + .../graph_objs/scatterpolar/selected/_textfont.py | 81 + .../graph_objs/scatterpolar/unselected/__init__.py | 12 + .../graph_objs/scatterpolar/unselected/_marker.py | 136 + .../scatterpolar/unselected/_textfont.py | 84 + .../plotly/graph_objs/scatterpolargl/__init__.py | 34 + .../graph_objs/scatterpolargl/_hoverlabel.py | 338 + .../graph_objs/scatterpolargl/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scatterpolargl/_line.py | 129 + .../plotly/graph_objs/scatterpolargl/_marker.py | 978 + .../plotly/graph_objs/scatterpolargl/_selected.py | 106 + .../plotly/graph_objs/scatterpolargl/_stream.py | 114 + .../plotly/graph_objs/scatterpolargl/_textfont.py | 399 + .../graph_objs/scatterpolargl/_unselected.py | 106 + .../scatterpolargl/hoverlabel/__init__.py | 9 + .../graph_objs/scatterpolargl/hoverlabel/_font.py | 587 + .../scatterpolargl/legendgrouptitle/__init__.py | 9 + .../scatterpolargl/legendgrouptitle/_font.py | 334 + .../graph_objs/scatterpolargl/marker/__init__.py | 13 + .../graph_objs/scatterpolargl/marker/_colorbar.py | 1722 ++ .../graph_objs/scatterpolargl/marker/_line.py | 546 + .../scatterpolargl/marker/colorbar/__init__.py | 16 + .../scatterpolargl/marker/colorbar/_tickfont.py | 334 + .../marker/colorbar/_tickformatstop.py | 241 + .../scatterpolargl/marker/colorbar/_title.py | 136 + .../marker/colorbar/title/__init__.py | 9 + .../scatterpolargl/marker/colorbar/title/_font.py | 334 + .../graph_objs/scatterpolargl/selected/__init__.py | 12 + .../graph_objs/scatterpolargl/selected/_marker.py | 127 + .../scatterpolargl/selected/_textfont.py | 81 + .../scatterpolargl/unselected/__init__.py | 12 + .../scatterpolargl/unselected/_marker.py | 136 + .../scatterpolargl/unselected/_textfont.py | 84 + .../plotly/graph_objs/scattersmith/__init__.py | 34 + .../plotly/graph_objs/scattersmith/_hoverlabel.py | 338 + .../graph_objs/scattersmith/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scattersmith/_line.py | 277 + .../plotly/graph_objs/scattersmith/_marker.py | 1130 + .../plotly/graph_objs/scattersmith/_selected.py | 106 + .../plotly/graph_objs/scattersmith/_stream.py | 114 + .../plotly/graph_objs/scattersmith/_textfont.py | 587 + .../plotly/graph_objs/scattersmith/_unselected.py | 106 + .../graph_objs/scattersmith/hoverlabel/__init__.py | 9 + .../graph_objs/scattersmith/hoverlabel/_font.py | 587 + .../scattersmith/legendgrouptitle/__init__.py | 9 + .../scattersmith/legendgrouptitle/_font.py | 334 + .../graph_objs/scattersmith/marker/__init__.py | 16 + .../graph_objs/scattersmith/marker/_colorbar.py | 1722 ++ .../graph_objs/scattersmith/marker/_gradient.py | 164 + .../plotly/graph_objs/scattersmith/marker/_line.py | 546 + .../scattersmith/marker/colorbar/__init__.py | 16 + .../scattersmith/marker/colorbar/_tickfont.py | 334 + .../marker/colorbar/_tickformatstop.py | 241 + .../scattersmith/marker/colorbar/_title.py | 136 + .../scattersmith/marker/colorbar/title/__init__.py | 9 + .../scattersmith/marker/colorbar/title/_font.py | 334 + .../graph_objs/scattersmith/selected/__init__.py | 12 + .../graph_objs/scattersmith/selected/_marker.py | 127 + .../graph_objs/scattersmith/selected/_textfont.py | 81 + .../graph_objs/scattersmith/unselected/__init__.py | 12 + .../graph_objs/scattersmith/unselected/_marker.py | 136 + .../scattersmith/unselected/_textfont.py | 84 + .../plotly/graph_objs/scatterternary/__init__.py | 34 + .../graph_objs/scatterternary/_hoverlabel.py | 338 + .../graph_objs/scatterternary/_legendgrouptitle.py | 104 + .../plotly/graph_objs/scatterternary/_line.py | 277 + .../plotly/graph_objs/scatterternary/_marker.py | 1130 + .../plotly/graph_objs/scatterternary/_selected.py | 106 + .../plotly/graph_objs/scatterternary/_stream.py | 114 + .../plotly/graph_objs/scatterternary/_textfont.py | 587 + .../graph_objs/scatterternary/_unselected.py | 106 + .../scatterternary/hoverlabel/__init__.py | 9 + .../graph_objs/scatterternary/hoverlabel/_font.py | 587 + .../scatterternary/legendgrouptitle/__init__.py | 9 + .../scatterternary/legendgrouptitle/_font.py | 334 + .../graph_objs/scatterternary/marker/__init__.py | 16 + .../graph_objs/scatterternary/marker/_colorbar.py | 1722 ++ .../graph_objs/scatterternary/marker/_gradient.py | 164 + .../graph_objs/scatterternary/marker/_line.py | 546 + .../scatterternary/marker/colorbar/__init__.py | 16 + .../scatterternary/marker/colorbar/_tickfont.py | 334 + .../marker/colorbar/_tickformatstop.py | 241 + .../scatterternary/marker/colorbar/_title.py | 136 + .../marker/colorbar/title/__init__.py | 9 + .../scatterternary/marker/colorbar/title/_font.py | 334 + .../graph_objs/scatterternary/selected/__init__.py | 12 + .../graph_objs/scatterternary/selected/_marker.py | 127 + .../scatterternary/selected/_textfont.py | 81 + .../scatterternary/unselected/__init__.py | 12 + .../scatterternary/unselected/_marker.py | 136 + .../scatterternary/unselected/_textfont.py | 84 + .../plotly/graph_objs/splom/__init__.py | 42 + .../plotly/graph_objs/splom/_diagonal.py | 80 + .../plotly/graph_objs/splom/_dimension.py | 293 + .../plotly/graph_objs/splom/_hoverlabel.py | 338 + .../plotly/graph_objs/splom/_legendgrouptitle.py | 104 + .../plotly/graph_objs/splom/_marker.py | 977 + .../plotly/graph_objs/splom/_selected.py | 80 + .../plotly/graph_objs/splom/_stream.py | 113 + .../plotly/graph_objs/splom/_unselected.py | 80 + .../plotly/graph_objs/splom/dimension/__init__.py | 9 + .../plotly/graph_objs/splom/dimension/_axis.py | 115 + .../plotly/graph_objs/splom/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/splom/hoverlabel/_font.py | 587 + .../graph_objs/splom/legendgrouptitle/__init__.py | 9 + .../graph_objs/splom/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/splom/marker/__init__.py | 13 + .../plotly/graph_objs/splom/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/splom/marker/_line.py | 546 + .../graph_objs/splom/marker/colorbar/__init__.py | 16 + .../graph_objs/splom/marker/colorbar/_tickfont.py | 334 + .../splom/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/splom/marker/colorbar/_title.py | 136 + .../splom/marker/colorbar/title/__init__.py | 9 + .../splom/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/splom/selected/__init__.py | 9 + .../plotly/graph_objs/splom/selected/_marker.py | 127 + .../plotly/graph_objs/splom/unselected/__init__.py | 9 + .../plotly/graph_objs/splom/unselected/_marker.py | 136 + .../plotly/graph_objs/streamtube/__init__.py | 30 + .../plotly/graph_objs/streamtube/_colorbar.py | 1721 ++ .../plotly/graph_objs/streamtube/_hoverlabel.py | 338 + .../graph_objs/streamtube/_legendgrouptitle.py | 104 + .../plotly/graph_objs/streamtube/_lighting.py | 260 + .../plotly/graph_objs/streamtube/_lightposition.py | 129 + .../plotly/graph_objs/streamtube/_starts.py | 217 + .../plotly/graph_objs/streamtube/_stream.py | 114 + .../graph_objs/streamtube/colorbar/__init__.py | 16 + .../graph_objs/streamtube/colorbar/_tickfont.py | 334 + .../streamtube/colorbar/_tickformatstop.py | 241 + .../graph_objs/streamtube/colorbar/_title.py | 136 + .../streamtube/colorbar/title/__init__.py | 9 + .../graph_objs/streamtube/colorbar/title/_font.py | 334 + .../graph_objs/streamtube/hoverlabel/__init__.py | 9 + .../graph_objs/streamtube/hoverlabel/_font.py | 587 + .../streamtube/legendgrouptitle/__init__.py | 9 + .../streamtube/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/sunburst/__init__.py | 36 + .../plotly/graph_objs/sunburst/_domain.py | 170 + .../plotly/graph_objs/sunburst/_hoverlabel.py | 338 + .../plotly/graph_objs/sunburst/_insidetextfont.py | 587 + .../plotly/graph_objs/sunburst/_leaf.py | 79 + .../graph_objs/sunburst/_legendgrouptitle.py | 104 + .../plotly/graph_objs/sunburst/_marker.py | 579 + .../plotly/graph_objs/sunburst/_outsidetextfont.py | 591 + .../plotly/graph_objs/sunburst/_root.py | 86 + .../plotly/graph_objs/sunburst/_stream.py | 114 + .../plotly/graph_objs/sunburst/_textfont.py | 587 + .../graph_objs/sunburst/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/sunburst/hoverlabel/_font.py | 587 + .../sunburst/legendgrouptitle/__init__.py | 9 + .../graph_objs/sunburst/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/sunburst/marker/__init__.py | 16 + .../plotly/graph_objs/sunburst/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/sunburst/marker/_line.py | 163 + .../plotly/graph_objs/sunburst/marker/_pattern.py | 433 + .../sunburst/marker/colorbar/__init__.py | 16 + .../sunburst/marker/colorbar/_tickfont.py | 334 + .../sunburst/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/sunburst/marker/colorbar/_title.py | 136 + .../sunburst/marker/colorbar/title/__init__.py | 9 + .../sunburst/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/surface/__init__.py | 31 + .../plotly/graph_objs/surface/_colorbar.py | 1722 ++ .../plotly/graph_objs/surface/_contours.py | 132 + .../plotly/graph_objs/surface/_hoverlabel.py | 338 + .../plotly/graph_objs/surface/_legendgrouptitle.py | 104 + .../plotly/graph_objs/surface/_lighting.py | 198 + .../plotly/graph_objs/surface/_lightposition.py | 129 + .../plotly/graph_objs/surface/_stream.py | 114 + .../plotly/graph_objs/surface/colorbar/__init__.py | 16 + .../graph_objs/surface/colorbar/_tickfont.py | 334 + .../graph_objs/surface/colorbar/_tickformatstop.py | 241 + .../plotly/graph_objs/surface/colorbar/_title.py | 136 + .../graph_objs/surface/colorbar/title/__init__.py | 9 + .../graph_objs/surface/colorbar/title/_font.py | 334 + .../plotly/graph_objs/surface/contours/__init__.py | 16 + .../plotly/graph_objs/surface/contours/_x.py | 362 + .../plotly/graph_objs/surface/contours/_y.py | 362 + .../plotly/graph_objs/surface/contours/_z.py | 362 + .../graph_objs/surface/contours/x/__init__.py | 9 + .../graph_objs/surface/contours/x/_project.py | 156 + .../graph_objs/surface/contours/y/__init__.py | 9 + .../graph_objs/surface/contours/y/_project.py | 156 + .../graph_objs/surface/contours/z/__init__.py | 9 + .../graph_objs/surface/contours/z/_project.py | 156 + .../graph_objs/surface/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/surface/hoverlabel/_font.py | 587 + .../surface/legendgrouptitle/__init__.py | 9 + .../graph_objs/surface/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/table/__init__.py | 29 + .../plotly/graph_objs/table/_cells.py | 464 + .../plotly/graph_objs/table/_domain.py | 169 + .../plotly/graph_objs/table/_header.py | 464 + .../plotly/graph_objs/table/_hoverlabel.py | 338 + .../plotly/graph_objs/table/_legendgrouptitle.py | 104 + .../plotly/graph_objs/table/_stream.py | 113 + .../plotly/graph_objs/table/cells/__init__.py | 13 + .../plotly/graph_objs/table/cells/_fill.py | 110 + .../plotly/graph_objs/table/cells/_font.py | 585 + .../plotly/graph_objs/table/cells/_line.py | 154 + .../plotly/graph_objs/table/header/__init__.py | 13 + .../plotly/graph_objs/table/header/_fill.py | 110 + .../plotly/graph_objs/table/header/_font.py | 585 + .../plotly/graph_objs/table/header/_line.py | 154 + .../plotly/graph_objs/table/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/table/hoverlabel/_font.py | 587 + .../graph_objs/table/legendgrouptitle/__init__.py | 9 + .../graph_objs/table/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/treemap/__init__.py | 39 + .../plotly/graph_objs/treemap/_domain.py | 170 + .../plotly/graph_objs/treemap/_hoverlabel.py | 338 + .../plotly/graph_objs/treemap/_insidetextfont.py | 587 + .../plotly/graph_objs/treemap/_legendgrouptitle.py | 104 + .../plotly/graph_objs/treemap/_marker.py | 681 + .../plotly/graph_objs/treemap/_outsidetextfont.py | 591 + .../plotly/graph_objs/treemap/_pathbar.py | 198 + .../plotly/graph_objs/treemap/_root.py | 86 + .../plotly/graph_objs/treemap/_stream.py | 114 + .../plotly/graph_objs/treemap/_textfont.py | 587 + .../plotly/graph_objs/treemap/_tiling.py | 195 + .../graph_objs/treemap/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/treemap/hoverlabel/_font.py | 587 + .../treemap/legendgrouptitle/__init__.py | 9 + .../graph_objs/treemap/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/treemap/marker/__init__.py | 17 + .../plotly/graph_objs/treemap/marker/_colorbar.py | 1722 ++ .../plotly/graph_objs/treemap/marker/_line.py | 163 + .../plotly/graph_objs/treemap/marker/_pad.py | 146 + .../plotly/graph_objs/treemap/marker/_pattern.py | 433 + .../graph_objs/treemap/marker/colorbar/__init__.py | 16 + .../treemap/marker/colorbar/_tickfont.py | 334 + .../treemap/marker/colorbar/_tickformatstop.py | 241 + .../graph_objs/treemap/marker/colorbar/_title.py | 136 + .../treemap/marker/colorbar/title/__init__.py | 9 + .../treemap/marker/colorbar/title/_font.py | 334 + .../plotly/graph_objs/treemap/pathbar/__init__.py | 11 + .../plotly/graph_objs/treemap/pathbar/_textfont.py | 587 + .../plotly/graph_objs/violin/__init__.py | 44 + .../site-packages/plotly/graph_objs/violin/_box.py | 163 + .../plotly/graph_objs/violin/_hoverlabel.py | 338 + .../plotly/graph_objs/violin/_legendgrouptitle.py | 104 + .../plotly/graph_objs/violin/_line.py | 103 + .../plotly/graph_objs/violin/_marker.py | 357 + .../plotly/graph_objs/violin/_meanline.py | 138 + .../plotly/graph_objs/violin/_selected.py | 80 + .../plotly/graph_objs/violin/_stream.py | 113 + .../plotly/graph_objs/violin/_unselected.py | 80 + .../plotly/graph_objs/violin/box/__init__.py | 9 + .../plotly/graph_objs/violin/box/_line.py | 104 + .../graph_objs/violin/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/violin/hoverlabel/_font.py | 587 + .../graph_objs/violin/legendgrouptitle/__init__.py | 9 + .../graph_objs/violin/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/violin/marker/__init__.py | 9 + .../plotly/graph_objs/violin/marker/_line.py | 181 + .../plotly/graph_objs/violin/selected/__init__.py | 9 + .../plotly/graph_objs/violin/selected/_marker.py | 127 + .../graph_objs/violin/unselected/__init__.py | 9 + .../plotly/graph_objs/violin/unselected/_marker.py | 136 + .../plotly/graph_objs/volume/__init__.py | 40 + .../plotly/graph_objs/volume/_caps.py | 131 + .../plotly/graph_objs/volume/_colorbar.py | 1722 ++ .../plotly/graph_objs/volume/_contour.py | 127 + .../plotly/graph_objs/volume/_hoverlabel.py | 338 + .../plotly/graph_objs/volume/_legendgrouptitle.py | 104 + .../plotly/graph_objs/volume/_lighting.py | 260 + .../plotly/graph_objs/volume/_lightposition.py | 129 + .../plotly/graph_objs/volume/_slices.py | 131 + .../plotly/graph_objs/volume/_spaceframe.py | 117 + .../plotly/graph_objs/volume/_stream.py | 113 + .../plotly/graph_objs/volume/_surface.py | 193 + .../plotly/graph_objs/volume/caps/__init__.py | 13 + .../plotly/graph_objs/volume/caps/_x.py | 121 + .../plotly/graph_objs/volume/caps/_y.py | 121 + .../plotly/graph_objs/volume/caps/_z.py | 121 + .../plotly/graph_objs/volume/colorbar/__init__.py | 16 + .../plotly/graph_objs/volume/colorbar/_tickfont.py | 334 + .../graph_objs/volume/colorbar/_tickformatstop.py | 241 + .../plotly/graph_objs/volume/colorbar/_title.py | 136 + .../graph_objs/volume/colorbar/title/__init__.py | 9 + .../graph_objs/volume/colorbar/title/_font.py | 334 + .../graph_objs/volume/hoverlabel/__init__.py | 9 + .../plotly/graph_objs/volume/hoverlabel/_font.py | 587 + .../graph_objs/volume/legendgrouptitle/__init__.py | 9 + .../graph_objs/volume/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/volume/slices/__init__.py | 13 + .../plotly/graph_objs/volume/slices/_x.py | 177 + .../plotly/graph_objs/volume/slices/_y.py | 177 + .../plotly/graph_objs/volume/slices/_z.py | 177 + .../plotly/graph_objs/waterfall/__init__.py | 46 + .../plotly/graph_objs/waterfall/_connector.py | 127 + .../plotly/graph_objs/waterfall/_decreasing.py | 80 + .../plotly/graph_objs/waterfall/_hoverlabel.py | 338 + .../plotly/graph_objs/waterfall/_increasing.py | 80 + .../plotly/graph_objs/waterfall/_insidetextfont.py | 587 + .../graph_objs/waterfall/_legendgrouptitle.py | 104 + .../graph_objs/waterfall/_outsidetextfont.py | 587 + .../plotly/graph_objs/waterfall/_stream.py | 114 + .../plotly/graph_objs/waterfall/_textfont.py | 587 + .../plotly/graph_objs/waterfall/_totals.py | 80 + .../graph_objs/waterfall/connector/__init__.py | 9 + .../plotly/graph_objs/waterfall/connector/_line.py | 139 + .../graph_objs/waterfall/decreasing/__init__.py | 12 + .../graph_objs/waterfall/decreasing/_marker.py | 107 + .../waterfall/decreasing/marker/__init__.py | 9 + .../waterfall/decreasing/marker/_line.py | 104 + .../graph_objs/waterfall/hoverlabel/__init__.py | 9 + .../graph_objs/waterfall/hoverlabel/_font.py | 587 + .../graph_objs/waterfall/increasing/__init__.py | 12 + .../graph_objs/waterfall/increasing/_marker.py | 107 + .../waterfall/increasing/marker/__init__.py | 9 + .../waterfall/increasing/marker/_line.py | 104 + .../waterfall/legendgrouptitle/__init__.py | 9 + .../graph_objs/waterfall/legendgrouptitle/_font.py | 334 + .../plotly/graph_objs/waterfall/totals/__init__.py | 12 + .../plotly/graph_objs/waterfall/totals/_marker.py | 110 + .../graph_objs/waterfall/totals/marker/__init__.py | 9 + .../graph_objs/waterfall/totals/marker/_line.py | 108 + 1512 files changed, 514939 insertions(+) create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_bar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_barpolar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_box.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_candlestick.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_carpet.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_choropleth.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_cone.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_contour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_contourcarpet.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_deprecations.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_figure.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_figurewidget.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_frame.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_funnel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_funnelarea.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_heatmap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2d.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2dcontour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_icicle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_image.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_indicator.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_isosurface.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_layout.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_mesh3d.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_ohlc.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_parcats.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_parcoords.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_pie.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_sankey.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter3d.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scattercarpet.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergeo.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergl.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolargl.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scattersmith.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterternary.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_splom.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_streamtube.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_sunburst.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_surface.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_table.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_treemap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_violin.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_volume.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/_waterfall.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_decreasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_increasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_aaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_baxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lighting.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lightposition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_contours.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/_labelfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_contours.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/_labelfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_connector.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/graph_objs.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_cumulative.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_xbins.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_ybins.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_xbins.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_ybins.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_contours.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_xbins.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_ybins.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_leaf.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_pathbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_root.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_tiling.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_delta.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_gauge.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_number.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_decreasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_increasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_axis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_bar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_step.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_threshold.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_caps.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_contour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lighting.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lightposition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_slices.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_spaceframe.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_surface.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeselection.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeshape.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_annotation.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_coloraxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_colorscale.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_geo.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_grid.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_image.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_legend.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_map.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_mapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_margin.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_modebar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newselection.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newshape.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_polar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_scene.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_selection.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_shape.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_slider.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_smith.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_template.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_ternary.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_transition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_uniformtext.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_updatemenu.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_xaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_yaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_center.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lataxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lonaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_projection.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/_rotation.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_grouptitlefont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_grouptitlefont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_bounds.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_center.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_layer.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_circle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_fill.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_symbol.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_bounds.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_center.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_layer.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_circle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_fill.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_symbol.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_label.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_angularaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_radialaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_autorangeoptions.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_annotation.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_aspectratio.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_camera.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_xaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_yaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_zaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_center.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_eye.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_projection.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_up.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_autorangeoptions.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_autorangeoptions.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_autorangeoptions.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_label.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_currentvalue.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_pad.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_step.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_transition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_imaginaryaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_realaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_data.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_layout.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_bar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_barpolar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_box.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_candlestick.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_carpet.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choropleth.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_cone.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contourcarpet.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnelarea.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_heatmap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2d.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2dcontour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_icicle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_image.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_indicator.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_isosurface.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_mesh3d.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_ohlc.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcats.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcoords.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_pie.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sankey.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter3d.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattercarpet.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergeo.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergl.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermapbox.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolargl.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattersmith.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterternary.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_splom.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_streamtube.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sunburst.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_surface.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_table.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_treemap.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_violin.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_volume.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_waterfall.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_aaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_baxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_caxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_pad.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_subtitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_button.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_pad.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_autorangeoptions.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_minor.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangebreak.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeselector.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeslider.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_button.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_autorangeoptions.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_minor.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_rangebreak.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_contour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lighting.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lightposition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_decreasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_increasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_dimension.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_labelfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_dimension.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_labelfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_rangefont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_link.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_node.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_colorscale.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillgradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillpattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_gradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_projection.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_gradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_gradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_cluster.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_cluster.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_gradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_gradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_gradient.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_diagonal.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_dimension.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/_axis.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lighting.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lightposition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_starts.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_leaf.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_root.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_contours.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lighting.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lightposition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/_project.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/_project.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/_project.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/_cells.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/_header.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_fill.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_fill.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_domain.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_pathbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_root.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_tiling.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pad.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pattern.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_box.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_meanline.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_selected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_unselected.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_caps.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_colorbar.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_contour.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lighting.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lightposition.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_slices.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_spaceframe.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_surface.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickformatstop.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_title.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_x.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_y.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_z.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_connector.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_decreasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_hoverlabel.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_increasing.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_insidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_legendgrouptitle.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_outsidetextfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_stream.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_textfont.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_totals.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/_line.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/_font.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/_marker.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/__init__.py create mode 100644 venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/_line.py (limited to 'venv/lib/python3.8/site-packages/plotly/graph_objs') diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/__init__.py new file mode 100644 index 0000000..57a7317 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/__init__.py @@ -0,0 +1,305 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._bar import Bar + from ._barpolar import Barpolar + from ._box import Box + from ._candlestick import Candlestick + from ._carpet import Carpet + from ._choropleth import Choropleth + from ._choroplethmap import Choroplethmap + from ._choroplethmapbox import Choroplethmapbox + from ._cone import Cone + from ._contour import Contour + from ._contourcarpet import Contourcarpet + from ._densitymap import Densitymap + from ._densitymapbox import Densitymapbox + from ._deprecations import AngularAxis + from ._deprecations import Annotation + from ._deprecations import Annotations + from ._deprecations import ColorBar + from ._deprecations import Contours + from ._deprecations import Data + from ._deprecations import ErrorX + from ._deprecations import ErrorY + from ._deprecations import ErrorZ + from ._deprecations import Font + from ._deprecations import Frames + from ._deprecations import Histogram2dcontour + from ._deprecations import Legend + from ._deprecations import Line + from ._deprecations import Margin + from ._deprecations import Marker + from ._deprecations import RadialAxis + from ._deprecations import Scene + from ._deprecations import Stream + from ._deprecations import Trace + from ._deprecations import XAxis + from ._deprecations import XBins + from ._deprecations import YAxis + from ._deprecations import YBins + from ._deprecations import ZAxis + from ._figure import Figure + from ._frame import Frame + from ._funnel import Funnel + from ._funnelarea import Funnelarea + from ._heatmap import Heatmap + from ._histogram import Histogram + from ._histogram2d import Histogram2d + from ._histogram2dcontour import Histogram2dContour + from ._icicle import Icicle + from ._image import Image + from ._indicator import Indicator + from ._isosurface import Isosurface + from ._layout import Layout + from ._mesh3d import Mesh3d + from ._ohlc import Ohlc + from ._parcats import Parcats + from ._parcoords import Parcoords + from ._pie import Pie + from ._sankey import Sankey + from ._scatter import Scatter + from ._scatter3d import Scatter3d + from ._scattercarpet import Scattercarpet + from ._scattergeo import Scattergeo + from ._scattergl import Scattergl + from ._scattermap import Scattermap + from ._scattermapbox import Scattermapbox + from ._scatterpolar import Scatterpolar + from ._scatterpolargl import Scatterpolargl + from ._scattersmith import Scattersmith + from ._scatterternary import Scatterternary + from ._splom import Splom + from ._streamtube import Streamtube + from ._sunburst import Sunburst + from ._surface import Surface + from ._table import Table + from ._treemap import Treemap + from ._violin import Violin + from ._volume import Volume + from ._waterfall import Waterfall + from . import bar + from . import barpolar + from . import box + from . import candlestick + from . import carpet + from . import choropleth + from . import choroplethmap + from . import choroplethmapbox + from . import cone + from . import contour + from . import contourcarpet + from . import densitymap + from . import densitymapbox + from . import funnel + from . import funnelarea + from . import heatmap + from . import histogram + from . import histogram2d + from . import histogram2dcontour + from . import icicle + from . import image + from . import indicator + from . import isosurface + from . import layout + from . import mesh3d + from . import ohlc + from . import parcats + from . import parcoords + from . import pie + from . import sankey + from . import scatter + from . import scatter3d + from . import scattercarpet + from . import scattergeo + from . import scattergl + from . import scattermap + from . import scattermapbox + from . import scatterpolar + from . import scatterpolargl + from . import scattersmith + from . import scatterternary + from . import splom + from . import streamtube + from . import sunburst + from . import surface + from . import table + from . import treemap + from . import violin + from . import volume + from . import waterfall +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".bar", + ".barpolar", + ".box", + ".candlestick", + ".carpet", + ".choropleth", + ".choroplethmap", + ".choroplethmapbox", + ".cone", + ".contour", + ".contourcarpet", + ".densitymap", + ".densitymapbox", + ".funnel", + ".funnelarea", + ".heatmap", + ".histogram", + ".histogram2d", + ".histogram2dcontour", + ".icicle", + ".image", + ".indicator", + ".isosurface", + ".layout", + ".mesh3d", + ".ohlc", + ".parcats", + ".parcoords", + ".pie", + ".sankey", + ".scatter", + ".scatter3d", + ".scattercarpet", + ".scattergeo", + ".scattergl", + ".scattermap", + ".scattermapbox", + ".scatterpolar", + ".scatterpolargl", + ".scattersmith", + ".scatterternary", + ".splom", + ".streamtube", + ".sunburst", + ".surface", + ".table", + ".treemap", + ".violin", + ".volume", + ".waterfall", + ], + [ + "._bar.Bar", + "._barpolar.Barpolar", + "._box.Box", + "._candlestick.Candlestick", + "._carpet.Carpet", + "._choropleth.Choropleth", + "._choroplethmap.Choroplethmap", + "._choroplethmapbox.Choroplethmapbox", + "._cone.Cone", + "._contour.Contour", + "._contourcarpet.Contourcarpet", + "._densitymap.Densitymap", + "._densitymapbox.Densitymapbox", + "._deprecations.AngularAxis", + "._deprecations.Annotation", + "._deprecations.Annotations", + "._deprecations.ColorBar", + "._deprecations.Contours", + "._deprecations.Data", + "._deprecations.ErrorX", + "._deprecations.ErrorY", + "._deprecations.ErrorZ", + "._deprecations.Font", + "._deprecations.Frames", + "._deprecations.Histogram2dcontour", + "._deprecations.Legend", + "._deprecations.Line", + "._deprecations.Margin", + "._deprecations.Marker", + "._deprecations.RadialAxis", + "._deprecations.Scene", + "._deprecations.Stream", + "._deprecations.Trace", + "._deprecations.XAxis", + "._deprecations.XBins", + "._deprecations.YAxis", + "._deprecations.YBins", + "._deprecations.ZAxis", + "._figure.Figure", + "._frame.Frame", + "._funnel.Funnel", + "._funnelarea.Funnelarea", + "._heatmap.Heatmap", + "._histogram.Histogram", + "._histogram2d.Histogram2d", + "._histogram2dcontour.Histogram2dContour", + "._icicle.Icicle", + "._image.Image", + "._indicator.Indicator", + "._isosurface.Isosurface", + "._layout.Layout", + "._mesh3d.Mesh3d", + "._ohlc.Ohlc", + "._parcats.Parcats", + "._parcoords.Parcoords", + "._pie.Pie", + "._sankey.Sankey", + "._scatter.Scatter", + "._scatter3d.Scatter3d", + "._scattercarpet.Scattercarpet", + "._scattergeo.Scattergeo", + "._scattergl.Scattergl", + "._scattermap.Scattermap", + "._scattermapbox.Scattermapbox", + "._scatterpolar.Scatterpolar", + "._scatterpolargl.Scatterpolargl", + "._scattersmith.Scattersmith", + "._scatterternary.Scatterternary", + "._splom.Splom", + "._streamtube.Streamtube", + "._sunburst.Sunburst", + "._surface.Surface", + "._table.Table", + "._treemap.Treemap", + "._violin.Violin", + "._volume.Volume", + "._waterfall.Waterfall", + ], + ) + + +if sys.version_info < (3, 7) or TYPE_CHECKING: + try: + import ipywidgets as _ipywidgets + from packaging.version import Version as _Version + + if _Version(_ipywidgets.__version__) >= _Version("7.0.0"): + from ..graph_objs._figurewidget import FigureWidget + else: + raise ImportError() + except Exception: + from ..missing_anywidget import FigureWidget +else: + __all__.append("FigureWidget") + orig_getattr = __getattr__ + + def __getattr__(import_name): + if import_name == "FigureWidget": + try: + import ipywidgets + from packaging.version import Version + + if Version(ipywidgets.__version__) >= Version("7.0.0"): + from ..graph_objs._figurewidget import FigureWidget + + return FigureWidget + else: + raise ImportError() + except Exception: + from ..missing_anywidget import FigureWidget + + return FigureWidget + else: + raise ImportError() + + return orig_getattr(import_name) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_bar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_bar.py new file mode 100644 index 0000000..0e12061 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_bar.py @@ -0,0 +1,2598 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Bar(_BaseTraceType): + _parent_path_str = "" + _path_str = "bar" + _valid_props = { + "alignmentgroup", + "base", + "basesrc", + "cliponaxis", + "constraintext", + "customdata", + "customdatasrc", + "dx", + "dy", + "error_x", + "error_y", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextanchor", + "insidetextfont", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "offset", + "offsetgroup", + "offsetsrc", + "opacity", + "orientation", + "outsidetextfont", + "selected", + "selectedpoints", + "showlegend", + "stream", + "text", + "textangle", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "width", + "widthsrc", + "x", + "x0", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "y", + "y0", + "yaxis", + "ycalendar", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def base(self): + """ + Sets where the bar base is drawn (in position axis units). In + "stack" or "relative" barmode, traces that set "base" will be + excluded and drawn in "overlay" mode instead. + + The 'base' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["base"] + + @base.setter + def base(self, val): + self["base"] = val + + @property + def basesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `base`. + + The 'basesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["basesrc"] + + @basesrc.setter + def basesrc(self, val): + self["basesrc"] = val + + @property + def cliponaxis(self): + """ + Determines whether the text nodes are clipped about the subplot + axes. To show the text nodes above axis lines and tick labels, + make sure to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def constraintext(self): + """ + Constrain the size of text inside or outside a bar to be no + larger than the bar itself. + + The 'constraintext' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'both', 'none'] + + Returns + ------- + Any + """ + return self["constraintext"] + + @constraintext.setter + def constraintext(self, val): + self["constraintext"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.ErrorX` + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Returns + ------- + plotly.graph_objs.bar.ErrorX + """ + return self["error_x"] + + @error_x.setter + def error_x(self, val): + self["error_x"] = val + + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.ErrorY` + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Returns + ------- + plotly.graph_objs.bar.ErrorY + """ + return self["error_y"] + + @error_y.setter + def error_y(self, val): + self["error_y"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.bar.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `value` and `label`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextanchor(self): + """ + Determines if texts are kept at center or start/end points in + `textposition` "inside" mode. + + The 'insidetextanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['end', 'middle', 'start'] + + Returns + ------- + Any + """ + return self["insidetextanchor"] + + @insidetextanchor.setter + def insidetextanchor(self, val): + self["insidetextanchor"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `text` lying inside the bar. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.bar.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.bar.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.bar.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def offset(self): + """ + Shifts the position where the bar is drawn (in position axis + units). In "group" barmode, traces that set "offset" will be + excluded and drawn in "overlay" mode instead. + + The 'offset' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def offsetsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `offset`. + + The 'offsetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["offsetsrc"] + + @offsetsrc.setter + def offsetsrc(self, val): + self["offsetsrc"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Sets the orientation of the bars. With "v" ("h"), the value of + the each bar spans along the vertical (horizontal). + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `text` lying outside the bar. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.bar.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.bar.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.bar.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle of the tick labels with respect to the bar. For + example, a `tickangle` of -90 draws the tick labels vertically. + With "auto" the texts may automatically be rotated to fit with + the maximum size in bars. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def textfont(self): + """ + Sets the font used for `text`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.bar.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Specifies the location of the `text`. "inside" positions `text` + inside, next to the bar end (rotated and scaled if needed). + "outside" positions `text` outside, next to the bar end (scaled + if needed), unless there is another bar stacked on this one, + then the text gets pushed inside. "auto" tries to position + `text` inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If "none", no + text appears. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'auto', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `value` + and `label`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.bar.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the bar width (in position axis units). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + base + Sets where the bar base is drawn (in position axis + units). In "stack" or "relative" barmode, traces that + set "base" will be excluded and drawn in "overlay" mode + instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties + error_y + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.bar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + base=None, + basesrc=None, + cliponaxis=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Bar object + + The data visualized by the span of the bars is set in `y` if + `orientation` is set to "v" (the default) and the labels are + set in `x`. By setting `orientation` to "h", the roles are + interchanged. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Bar` + 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. + base + Sets where the bar base is drawn (in position axis + units). In "stack" or "relative" barmode, traces that + set "base" will be excluded and drawn in "overlay" mode + instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties + error_y + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.bar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Bar + """ + super().__init__("bar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Bar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Bar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("base", arg, base) + self._set_property("basesrc", arg, basesrc) + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("constraintext", arg, constraintext) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("error_x", arg, error_x) + self._set_property("error_y", arg, error_y) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextanchor", arg, insidetextanchor) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("offset", arg, offset) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("offsetsrc", arg, offsetsrc) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "bar" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_barpolar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_barpolar.py new file mode 100644 index 0000000..a45eb7b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_barpolar.py @@ -0,0 +1,1606 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Barpolar(_BaseTraceType): + _parent_path_str = "" + _path_str = "barpolar" + _valid_props = { + "base", + "basesrc", + "customdata", + "customdatasrc", + "dr", + "dtheta", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "offset", + "offsetsrc", + "opacity", + "r", + "r0", + "rsrc", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "text", + "textsrc", + "theta", + "theta0", + "thetasrc", + "thetaunit", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "width", + "widthsrc", + } + + @property + def base(self): + """ + Sets where the bar base is drawn (in radial axis units). In + "stack" barmode, traces that set "base" will be excluded and + drawn in "overlay" mode instead. + + The 'base' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["base"] + + @base.setter + def base(self, val): + self["base"] = val + + @property + def basesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `base`. + + The 'basesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["basesrc"] + + @basesrc.setter + def basesrc(self, val): + self["basesrc"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dr(self): + """ + Sets the r coordinate step. + + The 'dr' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dr"] + + @dr.setter + def dr(self, val): + self["dr"] = val + + @property + def dtheta(self): + """ + Sets the theta coordinate step. By default, the `dtheta` step + equals the subplot's period divided by the length of the `r` + coordinates. + + The 'dtheta' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dtheta"] + + @dtheta.setter + def dtheta(self, val): + self["dtheta"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters + (e.g. 'r+theta') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.barpolar.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.barpolar.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.barpolar.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def offset(self): + """ + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + + The 'offset' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def offsetsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `offset`. + + The 'offsetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["offsetsrc"] + + @offsetsrc.setter + def offsetsrc(self, val): + self["offsetsrc"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def r(self): + """ + Sets the radial coordinates + + The 'r' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def r0(self): + """ + Alternate to `r`. Builds a linear space of r coordinates. Use + with `dr` where `r0` is the starting coordinate and `dr` the + step. + + The 'r0' property accepts values of any type + + Returns + ------- + Any + """ + return self["r0"] + + @r0.setter + def r0(self, val): + self["r0"] = val + + @property + def rsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `r`. + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["rsrc"] + + @rsrc.setter + def rsrc(self, val): + self["rsrc"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.barpolar.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.barpolar.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + polar subplot. If "polar" (the default value), the data refer + to `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'polar', that may be specified as the string 'polar' + optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + 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. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def theta(self): + """ + Sets the angular coordinates + + The 'theta' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["theta"] + + @theta.setter + def theta(self, val): + self["theta"] = val + + @property + def theta0(self): + """ + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the starting + coordinate and `dtheta` the step. + + The 'theta0' property accepts values of any type + + Returns + ------- + Any + """ + return self["theta0"] + + @theta0.setter + def theta0(self, val): + self["theta0"] = val + + @property + def thetasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `theta`. + + The 'thetasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["thetasrc"] + + @thetasrc.setter + def thetasrc(self, val): + self["thetasrc"] = val + + @property + def thetaunit(self): + """ + Sets the unit of input "theta" values. Has an effect only when + on "linear" angular axes. + + The 'thetaunit' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radians', 'degrees', 'gradians'] + + Returns + ------- + Any + """ + return self["thetaunit"] + + @thetaunit.setter + def thetaunit(self, val): + self["thetaunit"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.barpolar.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the bar angular width (in "thetaunit" units). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + base + Sets where the bar base is drawn (in radial axis + units). In "stack" barmode, traces that set "base" will + be excluded and drawn in "overlay" mode instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.barpolar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + 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. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties + 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). + width + Sets the bar angular width (in "thetaunit" units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + base=None, + basesrc=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetsrc=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Barpolar object + + The data visualized by the radial span of the bars is set in + `r` + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Barpolar` + base + Sets where the bar base is drawn (in radial axis + units). In "stack" barmode, traces that set "base" will + be excluded and drawn in "overlay" mode instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.barpolar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + 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. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties + 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). + width + Sets the bar angular width (in "thetaunit" units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Barpolar + """ + super().__init__("barpolar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Barpolar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Barpolar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("base", arg, base) + self._set_property("basesrc", arg, basesrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dr", arg, dr) + self._set_property("dtheta", arg, dtheta) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("offset", arg, offset) + self._set_property("offsetsrc", arg, offsetsrc) + self._set_property("opacity", arg, opacity) + self._set_property("r", arg, r) + self._set_property("r0", arg, r0) + self._set_property("rsrc", arg, rsrc) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("theta", arg, theta) + self._set_property("theta0", arg, theta0) + self._set_property("thetasrc", arg, thetasrc) + self._set_property("thetaunit", arg, thetaunit) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + + self._props["type"] = "barpolar" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_box.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_box.py new file mode 100644 index 0000000..34ef561 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_box.py @@ -0,0 +1,3050 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Box(_BaseTraceType): + _parent_path_str = "" + _path_str = "box" + _valid_props = { + "alignmentgroup", + "boxmean", + "boxpoints", + "customdata", + "customdatasrc", + "dx", + "dy", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "jitter", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "lowerfence", + "lowerfencesrc", + "marker", + "mean", + "meansrc", + "median", + "mediansrc", + "meta", + "metasrc", + "name", + "notched", + "notchspan", + "notchspansrc", + "notchwidth", + "offsetgroup", + "opacity", + "orientation", + "pointpos", + "q1", + "q1src", + "q3", + "q3src", + "quartilemethod", + "sd", + "sdmultiple", + "sdsrc", + "selected", + "selectedpoints", + "showlegend", + "showwhiskers", + "sizemode", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "unselected", + "upperfence", + "upperfencesrc", + "visible", + "whiskerwidth", + "width", + "x", + "x0", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "y", + "y0", + "yaxis", + "ycalendar", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def boxmean(self): + """ + If True, the mean of the box(es)' underlying distribution is + drawn as a dashed line inside the box(es). If "sd" the standard + deviation is also drawn. Defaults to True when `mean` is set. + Defaults to "sd" when `sd` is set Otherwise defaults to False. + + The 'boxmean' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'sd', False] + + Returns + ------- + Any + """ + return self["boxmean"] + + @boxmean.setter + def boxmean(self, val): + self["boxmean"] = val + + @property + def boxpoints(self): + """ + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier points + are shown and points either less than 4*Q1-3*Q3 or greater than + 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all + sample points are shown If False, only the box(es) are shown + with no sample points Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is set. + Defaults to "all" under the q1/median/q3 signature. Otherwise + defaults to "outliers". + + The 'boxpoints' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'outliers', 'suspectedoutliers', False] + + Returns + ------- + Any + """ + return self["boxpoints"] + + @boxpoints.setter + def boxpoints(self, val): + self["boxpoints"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step for multi-box traces set using + q1/median/q3. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step for multi-box traces set using + q1/median/q3. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.box.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual boxes or sample + points or both? + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['boxes', 'points'] joined with '+' characters + (e.g. 'boxes+points') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def jitter(self): + """ + Sets the amount of jitter in the sample points drawn. If 0, the + sample points align along the distribution axis. If 1, the + sample points are drawn in a random jitter of width equal to + the width of the box(es). + + The 'jitter' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["jitter"] + + @jitter.setter + def jitter(self, val): + self["jitter"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.box.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.box.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def lowerfence(self): + """ + Sets the lower fence values. There should be as many items as + the number of boxes desired. This attribute has effect only + under the q1/median/q3 signature. If `lowerfence` is not + provided but a sample (in `y` or `x`) is set, we compute the + lower as the last sample point below 1.5 times the IQR. + + The 'lowerfence' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lowerfence"] + + @lowerfence.setter + def lowerfence(self, val): + self["lowerfence"] = val + + @property + def lowerfencesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lowerfence`. + + The 'lowerfencesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lowerfencesrc"] + + @lowerfencesrc.setter + def lowerfencesrc(self, val): + self["lowerfencesrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.box.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def mean(self): + """ + Sets the mean values. There should be as many items as the + number of boxes desired. This attribute has effect only under + the q1/median/q3 signature. If `mean` is not provided but a + sample (in `y` or `x`) is set, we compute the mean for each box + using the sample values. + + The 'mean' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["mean"] + + @mean.setter + def mean(self, val): + self["mean"] = val + + @property + def meansrc(self): + """ + Sets the source reference on Chart Studio Cloud for `mean`. + + The 'meansrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["meansrc"] + + @meansrc.setter + def meansrc(self, val): + self["meansrc"] = val + + @property + def median(self): + """ + Sets the median values. There should be as many items as the + number of boxes desired. + + The 'median' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["median"] + + @median.setter + def median(self, val): + self["median"] = val + + @property + def mediansrc(self): + """ + Sets the source reference on Chart Studio Cloud for `median`. + + The 'mediansrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["mediansrc"] + + @mediansrc.setter + def mediansrc(self, val): + self["mediansrc"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. For box traces, the name will also be used for + the position coordinate, if `x` and `x0` (`y` and `y0` if + horizontal) are missing and the position axis is categorical + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def notched(self): + """ + Determines whether or not notches are drawn. Notches displays a + confidence interval around the median. We compute the + confidence interval as median +/- 1.57 * IQR / sqrt(N), where + IQR is the interquartile range and N is the sample size. If two + boxes' notches do not overlap there is 95% confidence their + medians differ. See + https://sites.google.com/site/davidsstatistics/home/notched- + box-plots for more info. Defaults to False unless `notchwidth` + or `notchspan` is set. + + The 'notched' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["notched"] + + @notched.setter + def notched(self, val): + self["notched"] = val + + @property + def notchspan(self): + """ + Sets the notch span from the boxes' `median` values. There + should be as many items as the number of boxes desired. This + attribute has effect only under the q1/median/q3 signature. If + `notchspan` is not provided but a sample (in `y` or `x`) is + set, we compute it as 1.57 * IQR / sqrt(N), where N is the + sample size. + + The 'notchspan' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["notchspan"] + + @notchspan.setter + def notchspan(self, val): + self["notchspan"] = val + + @property + def notchspansrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `notchspan`. + + The 'notchspansrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["notchspansrc"] + + @notchspansrc.setter + def notchspansrc(self, val): + self["notchspansrc"] = val + + @property + def notchwidth(self): + """ + Sets the width of the notches relative to the box' width. For + example, with 0, the notches are as wide as the box(es). + + The 'notchwidth' property is a number and may be specified as: + - An int or float in the interval [0, 0.5] + + Returns + ------- + int|float + """ + return self["notchwidth"] + + @notchwidth.setter + def notchwidth(self, val): + self["notchwidth"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical (horizontal). + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def pointpos(self): + """ + Sets the position of the sample points in relation to the + box(es). If 0, the sample points are places over the center of + the box(es). Positive (negative) values correspond to positions + to the right (left) for vertical boxes and above (below) for + horizontal boxes + + The 'pointpos' property is a number and may be specified as: + - An int or float in the interval [-2, 2] + + Returns + ------- + int|float + """ + return self["pointpos"] + + @pointpos.setter + def pointpos(self, val): + self["pointpos"] = val + + @property + def q1(self): + """ + Sets the Quartile 1 values. There should be as many items as + the number of boxes desired. + + The 'q1' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["q1"] + + @q1.setter + def q1(self, val): + self["q1"] = val + + @property + def q1src(self): + """ + Sets the source reference on Chart Studio Cloud for `q1`. + + The 'q1src' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["q1src"] + + @q1src.setter + def q1src(self, val): + self["q1src"] = val + + @property + def q3(self): + """ + Sets the Quartile 3 values. There should be as many items as + the number of boxes desired. + + The 'q3' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["q3"] + + @q3.setter + def q3(self, val): + self["q3"] = val + + @property + def q3src(self): + """ + Sets the source reference on Chart Studio Cloud for `q3`. + + The 'q3src' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["q3src"] + + @q3src.setter + def q3src(self, val): + self["q3src"] = val + + @property + def quartilemethod(self): + """ + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile for Q1 + and 75th percentile for Q3 as computed using method #10 (listed + on http://jse.amstat.org/v14n3/langford.html). The "exclusive" + method uses the median to divide the ordered dataset into two + halves if the sample is odd, it does not include the median in + either half - Q1 is then the median of the lower half and Q3 + the median of the upper half. The "inclusive" method also uses + the median to divide the ordered dataset into two halves but if + the sample is odd, it includes the median in both halves - Q1 + is then the median of the lower half and Q3 the median of the + upper half. + + The 'quartilemethod' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'exclusive', 'inclusive'] + + Returns + ------- + Any + """ + return self["quartilemethod"] + + @quartilemethod.setter + def quartilemethod(self, val): + self["quartilemethod"] = val + + @property + def sd(self): + """ + Sets the standard deviation values. There should be as many + items as the number of boxes desired. This attribute has effect + only under the q1/median/q3 signature. If `sd` is not provided + but a sample (in `y` or `x`) is set, we compute the standard + deviation for each box using the sample values. + + The 'sd' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["sd"] + + @sd.setter + def sd(self, val): + self["sd"] = val + + @property + def sdmultiple(self): + """ + Scales the box size when sizemode=sd Allowing boxes to be drawn + across any stddev range For example 1-stddev, 3-stddev, + 5-stddev + + The 'sdmultiple' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sdmultiple"] + + @sdmultiple.setter + def sdmultiple(self, val): + self["sdmultiple"] = val + + @property + def sdsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `sd`. + + The 'sdsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sdsrc"] + + @sdsrc.setter + def sdsrc(self, val): + self["sdsrc"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.box.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showwhiskers(self): + """ + Determines whether or not whiskers are visible. Defaults to + true for `sizemode` "quartiles", false for "sd". + + The 'showwhiskers' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showwhiskers"] + + @showwhiskers.setter + def showwhiskers(self, val): + self["showwhiskers"] = val + + @property + def sizemode(self): + """ + Sets the upper and lower bound for the boxes quartiles means + box is drawn between Q1 and Q3 SD means the box is drawn + between Mean +- Standard Deviation Argument sdmultiple (default + 1) to scale the box size So it could be drawn 1-stddev, + 3-stddev etc + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['quartiles', 'sd'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.box.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each sample value. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.box.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def upperfence(self): + """ + Sets the upper fence values. There should be as many items as + the number of boxes desired. This attribute has effect only + under the q1/median/q3 signature. If `upperfence` is not + provided but a sample (in `y` or `x`) is set, we compute the + upper as the last sample point above 1.5 times the IQR. + + The 'upperfence' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["upperfence"] + + @upperfence.setter + def upperfence(self, val): + self["upperfence"] = val + + @property + def upperfencesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `upperfence`. + + The 'upperfencesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["upperfencesrc"] + + @upperfencesrc.setter + def upperfencesrc(self, val): + self["upperfencesrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def whiskerwidth(self): + """ + Sets the width of the whiskers relative to the box' width. For + example, with 1, the whiskers are as wide as the box(es). + + The 'whiskerwidth' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["whiskerwidth"] + + @whiskerwidth.setter + def whiskerwidth(self, val): + self["whiskerwidth"] = val + + @property + def width(self): + """ + Sets the width of the box in data coordinate If 0 (default + value) the width is automatically selected based on the + positions of other box traces in the same subplot. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def x(self): + """ + Sets the x sample data or coordinates. See overview for more + info. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Sets the x coordinate for single-box traces or the starting + coordinate for multi-box traces set using q1/median/q3. See + overview for more info. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y sample data or coordinates. See overview for more + info. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Sets the y coordinate for single-box traces or the starting + coordinate for multi-box traces set using q1/median/q3. See + overview for more info. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside the + box(es). If "sd" the standard deviation is also drawn. + Defaults to True when `mean` is set. Defaults to "sd" + when `sd` is set Otherwise defaults to False. + boxpoints + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the box(es) are shown with no sample + points Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set. Defaults to "all" under the q1/median/q3 + signature. Otherwise defaults to "outliers". + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step for multi-box traces set + using q1/median/q3. + dy + Sets the y coordinate step for multi-box traces set + using q1/median/q3. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties + hoveron + Do the hover effects highlight individual boxes or + sample points or both? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the box(es). + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.box.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties + lowerfence + Sets the lower fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `lowerfence` is not provided but a sample (in `y` or + `x`) is set, we compute the lower as the last sample + point below 1.5 times the IQR. + lowerfencesrc + Sets the source reference on Chart Studio Cloud for + `lowerfence`. + marker + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties + mean + Sets the mean values. There should be as many items as + the number of boxes desired. This attribute has effect + only under the q1/median/q3 signature. If `mean` is not + provided but a sample (in `y` or `x`) is set, we + compute the mean for each box using the sample values. + meansrc + Sets the source reference on Chart Studio Cloud for + `mean`. + median + Sets the median values. There should be as many items + as the number of boxes desired. + mediansrc + Sets the source reference on Chart Studio Cloud for + `median`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + notched + Determines whether or not notches are drawn. Notches + displays a confidence interval around the median. We + compute the confidence interval as median +/- 1.57 * + IQR / sqrt(N), where IQR is the interquartile range and + N is the sample size. If two boxes' notches do not + overlap there is 95% confidence their medians differ. + See https://sites.google.com/site/davidsstatistics/home + /notched-box-plots for more info. Defaults to False + unless `notchwidth` or `notchspan` is set. + notchspan + Sets the notch span from the boxes' `median` values. + There should be as many items as the number of boxes + desired. This attribute has effect only under the + q1/median/q3 signature. If `notchspan` is not provided + but a sample (in `y` or `x`) is set, we compute it as + 1.57 * IQR / sqrt(N), where N is the sample size. + notchspansrc + Sets the source reference on Chart Studio Cloud for + `notchspan`. + notchwidth + Sets the width of the notches relative to the box' + width. For example, with 0, the notches are as wide as + the box(es). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the box(es). If 0, the sample points are places over + the center of the box(es). Positive (negative) values + correspond to positions to the right (left) for + vertical boxes and above (below) for horizontal boxes + q1 + Sets the Quartile 1 values. There should be as many + items as the number of boxes desired. + q1src + Sets the source reference on Chart Studio Cloud for + `q1`. + q3 + Sets the Quartile 3 values. There should be as many + items as the number of boxes desired. + q3src + Sets the source reference on Chart Studio Cloud for + `q3`. + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + sd + Sets the standard deviation values. There should be as + many items as the number of boxes desired. This + attribute has effect only under the q1/median/q3 + signature. If `sd` is not provided but a sample (in `y` + or `x`) is set, we compute the standard deviation for + each box using the sample values. + sdmultiple + Scales the box size when sizemode=sd Allowing boxes to + be drawn across any stddev range For example 1-stddev, + 3-stddev, 5-stddev + sdsrc + Sets the source reference on Chart Studio Cloud for + `sd`. + selected + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showwhiskers + Determines whether or not whiskers are visible. + Defaults to true for `sizemode` "quartiles", false for + "sd". + sizemode + Sets the upper and lower bound for the boxes quartiles + means box is drawn between Q1 and Q3 SD means the box + is drawn between Mean +- Standard Deviation Argument + sdmultiple (default 1) to scale the box size So it + could be drawn 1-stddev, 3-stddev etc + stream + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties + upperfence + Sets the upper fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `upperfence` is not provided but a sample (in `y` or + `x`) is set, we compute the upper as the last sample + point above 1.5 times the IQR. + upperfencesrc + Sets the source reference on Chart Studio Cloud for + `upperfence`. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + width + Sets the width of the box in data coordinate If 0 + (default value) the width is automatically selected + based on the positions of other box traces in the same + subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + boxmean=None, + boxpoints=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lowerfence=None, + lowerfencesrc=None, + marker=None, + mean=None, + meansrc=None, + median=None, + mediansrc=None, + meta=None, + metasrc=None, + name=None, + notched=None, + notchspan=None, + notchspansrc=None, + notchwidth=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + q1=None, + q1src=None, + q3=None, + q3src=None, + quartilemethod=None, + sd=None, + sdmultiple=None, + sdsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + showwhiskers=None, + sizemode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + upperfence=None, + upperfencesrc=None, + visible=None, + whiskerwidth=None, + width=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Box object + + Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The + second quartile (Q2, i.e. the median) is marked by a line + inside the box. The fences grow outward from the boxes' edges, + by default they span +/- 1.5 times the interquartile range + (IQR: Q3-Q1), The sample mean and standard deviation as well as + notches and the sample, outlier and suspected outliers points + can be optionally added to the box plot. The values and + positions corresponding to each boxes can be input using two + signatures. The first signature expects users to supply the + sample values in the `y` data array for vertical boxes (`x` for + horizontal boxes). By supplying an `x` (`y`) array, one box per + distinct `x` (`y`) value is drawn If no `x` (`y`) list is + provided, a single box is drawn. In this case, the box is + positioned with the trace `name` or with `x0` (`y0`) if + provided. The second signature expects users to supply the + boxes corresponding Q1, median and Q3 statistics in the `q1`, + `median` and `q3` data arrays respectively. Other box features + relying on statistics namely `lowerfence`, `upperfence`, + `notchspan` can be set directly by the users. To have plotly + compute them or to show sample points besides the boxes, users + can set the `y` data array for vertical boxes (`x` for + horizontal boxes) to a 2D array with the outer length + corresponding to the number of boxes in the traces and the + inner length corresponding the sample size. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Box` + 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. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside the + box(es). If "sd" the standard deviation is also drawn. + Defaults to True when `mean` is set. Defaults to "sd" + when `sd` is set Otherwise defaults to False. + boxpoints + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the box(es) are shown with no sample + points Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set. Defaults to "all" under the q1/median/q3 + signature. Otherwise defaults to "outliers". + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step for multi-box traces set + using q1/median/q3. + dy + Sets the y coordinate step for multi-box traces set + using q1/median/q3. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties + hoveron + Do the hover effects highlight individual boxes or + sample points or both? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the box(es). + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.box.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties + lowerfence + Sets the lower fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `lowerfence` is not provided but a sample (in `y` or + `x`) is set, we compute the lower as the last sample + point below 1.5 times the IQR. + lowerfencesrc + Sets the source reference on Chart Studio Cloud for + `lowerfence`. + marker + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties + mean + Sets the mean values. There should be as many items as + the number of boxes desired. This attribute has effect + only under the q1/median/q3 signature. If `mean` is not + provided but a sample (in `y` or `x`) is set, we + compute the mean for each box using the sample values. + meansrc + Sets the source reference on Chart Studio Cloud for + `mean`. + median + Sets the median values. There should be as many items + as the number of boxes desired. + mediansrc + Sets the source reference on Chart Studio Cloud for + `median`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + notched + Determines whether or not notches are drawn. Notches + displays a confidence interval around the median. We + compute the confidence interval as median +/- 1.57 * + IQR / sqrt(N), where IQR is the interquartile range and + N is the sample size. If two boxes' notches do not + overlap there is 95% confidence their medians differ. + See https://sites.google.com/site/davidsstatistics/home + /notched-box-plots for more info. Defaults to False + unless `notchwidth` or `notchspan` is set. + notchspan + Sets the notch span from the boxes' `median` values. + There should be as many items as the number of boxes + desired. This attribute has effect only under the + q1/median/q3 signature. If `notchspan` is not provided + but a sample (in `y` or `x`) is set, we compute it as + 1.57 * IQR / sqrt(N), where N is the sample size. + notchspansrc + Sets the source reference on Chart Studio Cloud for + `notchspan`. + notchwidth + Sets the width of the notches relative to the box' + width. For example, with 0, the notches are as wide as + the box(es). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the box(es). If 0, the sample points are places over + the center of the box(es). Positive (negative) values + correspond to positions to the right (left) for + vertical boxes and above (below) for horizontal boxes + q1 + Sets the Quartile 1 values. There should be as many + items as the number of boxes desired. + q1src + Sets the source reference on Chart Studio Cloud for + `q1`. + q3 + Sets the Quartile 3 values. There should be as many + items as the number of boxes desired. + q3src + Sets the source reference on Chart Studio Cloud for + `q3`. + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + sd + Sets the standard deviation values. There should be as + many items as the number of boxes desired. This + attribute has effect only under the q1/median/q3 + signature. If `sd` is not provided but a sample (in `y` + or `x`) is set, we compute the standard deviation for + each box using the sample values. + sdmultiple + Scales the box size when sizemode=sd Allowing boxes to + be drawn across any stddev range For example 1-stddev, + 3-stddev, 5-stddev + sdsrc + Sets the source reference on Chart Studio Cloud for + `sd`. + selected + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showwhiskers + Determines whether or not whiskers are visible. + Defaults to true for `sizemode` "quartiles", false for + "sd". + sizemode + Sets the upper and lower bound for the boxes quartiles + means box is drawn between Q1 and Q3 SD means the box + is drawn between Mean +- Standard Deviation Argument + sdmultiple (default 1) to scale the box size So it + could be drawn 1-stddev, 3-stddev etc + stream + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties + upperfence + Sets the upper fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `upperfence` is not provided but a sample (in `y` or + `x`) is set, we compute the upper as the last sample + point above 1.5 times the IQR. + upperfencesrc + Sets the source reference on Chart Studio Cloud for + `upperfence`. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + width + Sets the width of the box in data coordinate If 0 + (default value) the width is automatically selected + based on the positions of other box traces in the same + subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Box + """ + super().__init__("box") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Box +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Box`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("boxmean", arg, boxmean) + self._set_property("boxpoints", arg, boxpoints) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("jitter", arg, jitter) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("lowerfence", arg, lowerfence) + self._set_property("lowerfencesrc", arg, lowerfencesrc) + self._set_property("marker", arg, marker) + self._set_property("mean", arg, mean) + self._set_property("meansrc", arg, meansrc) + self._set_property("median", arg, median) + self._set_property("mediansrc", arg, mediansrc) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("notched", arg, notched) + self._set_property("notchspan", arg, notchspan) + self._set_property("notchspansrc", arg, notchspansrc) + self._set_property("notchwidth", arg, notchwidth) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("pointpos", arg, pointpos) + self._set_property("q1", arg, q1) + self._set_property("q1src", arg, q1src) + self._set_property("q3", arg, q3) + self._set_property("q3src", arg, q3src) + self._set_property("quartilemethod", arg, quartilemethod) + self._set_property("sd", arg, sd) + self._set_property("sdmultiple", arg, sdmultiple) + self._set_property("sdsrc", arg, sdsrc) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("showwhiskers", arg, showwhiskers) + self._set_property("sizemode", arg, sizemode) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("upperfence", arg, upperfence) + self._set_property("upperfencesrc", arg, upperfencesrc) + self._set_property("visible", arg, visible) + self._set_property("whiskerwidth", arg, whiskerwidth) + self._set_property("width", arg, width) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "box" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_candlestick.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_candlestick.py new file mode 100644 index 0000000..0a8d71a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_candlestick.py @@ -0,0 +1,1677 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Candlestick(_BaseTraceType): + _parent_path_str = "" + _path_str = "candlestick" + _valid_props = { + "close", + "closesrc", + "customdata", + "customdatasrc", + "decreasing", + "high", + "highsrc", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "increasing", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "low", + "lowsrc", + "meta", + "metasrc", + "name", + "opacity", + "open", + "opensrc", + "selectedpoints", + "showlegend", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "visible", + "whiskerwidth", + "x", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "yaxis", + "yhoverformat", + "zorder", + } + + @property + def close(self): + """ + Sets the close values. + + The 'close' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["close"] + + @close.setter + def close(self, val): + self["close"] = val + + @property + def closesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `close`. + + The 'closesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["closesrc"] + + @closesrc.setter + def closesrc(self, val): + self["closesrc"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def decreasing(self): + """ + The 'decreasing' property is an instance of Decreasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.Decreasing` + - A dict of string/value properties that will be passed + to the Decreasing constructor + + Returns + ------- + plotly.graph_objs.candlestick.Decreasing + """ + return self["decreasing"] + + @decreasing.setter + def decreasing(self, val): + self["decreasing"] = val + + @property + def high(self): + """ + Sets the high values. + + The 'high' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["high"] + + @high.setter + def high(self, val): + self["high"] = val + + @property + def highsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `high`. + + The 'highsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["highsrc"] + + @highsrc.setter + def highsrc(self, val): + self["highsrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.candlestick.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def increasing(self): + """ + The 'increasing' property is an instance of Increasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.Increasing` + - A dict of string/value properties that will be passed + to the Increasing constructor + + Returns + ------- + plotly.graph_objs.candlestick.Increasing + """ + return self["increasing"] + + @increasing.setter + def increasing(self, val): + self["increasing"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.candlestick.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.candlestick.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def low(self): + """ + Sets the low values. + + The 'low' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["low"] + + @low.setter + def low(self, val): + self["low"] = val + + @property + def lowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `low`. + + The 'lowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lowsrc"] + + @lowsrc.setter + def lowsrc(self, val): + self["lowsrc"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def open(self): + """ + Sets the open values. + + The 'open' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["open"] + + @open.setter + def open(self, val): + self["open"] = val + + @property + def opensrc(self): + """ + Sets the source reference on Chart Studio Cloud for `open`. + + The 'opensrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opensrc"] + + @opensrc.setter + def opensrc(self, val): + self["opensrc"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.candlestick.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets hover text elements associated with each sample point. If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + this trace's sample points. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def whiskerwidth(self): + """ + Sets the width of the whiskers relative to the box' width. For + example, with 1, the whiskers are as wide as the box(es). + + The 'whiskerwidth' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["whiskerwidth"] + + @whiskerwidth.setter + def whiskerwidth(self, val): + self["whiskerwidth"] = val + + @property + def x(self): + """ + Sets the x coordinates. If absent, linear coordinate will be + generated. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.candlestick.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + low=None, + lowsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + whiskerwidth=None, + x=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + yaxis=None, + yhoverformat=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Candlestick object + + The candlestick is a style of financial chart describing open, + high, low and close for a given `x` coordinate (most likely + time). The boxes represent the spread between the `open` and + `close` values and the lines represent the spread between the + `low` and `high` values Sample points where the close value is + higher (lower) then the open value are called increasing + (decreasing). By default, increasing candles are drawn in green + whereas decreasing are drawn in red. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Candlestick` + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.candlestick.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Candlestick + """ + super().__init__("candlestick") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Candlestick +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Candlestick`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("close", arg, close) + self._set_property("closesrc", arg, closesrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("decreasing", arg, decreasing) + self._set_property("high", arg, high) + self._set_property("highsrc", arg, highsrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("increasing", arg, increasing) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("low", arg, low) + self._set_property("lowsrc", arg, lowsrc) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("open", arg, open) + self._set_property("opensrc", arg, opensrc) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("whiskerwidth", arg, whiskerwidth) + self._set_property("x", arg, x) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("yaxis", arg, yaxis) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "candlestick" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_carpet.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_carpet.py new file mode 100644 index 0000000..b75b58a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_carpet.py @@ -0,0 +1,1257 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Carpet(_BaseTraceType): + _parent_path_str = "" + _path_str = "carpet" + _valid_props = { + "a", + "a0", + "aaxis", + "asrc", + "b", + "b0", + "baxis", + "bsrc", + "carpet", + "cheaterslope", + "color", + "customdata", + "customdatasrc", + "da", + "db", + "font", + "ids", + "idssrc", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "meta", + "metasrc", + "name", + "opacity", + "stream", + "type", + "uid", + "uirevision", + "visible", + "x", + "xaxis", + "xsrc", + "y", + "yaxis", + "ysrc", + "zorder", + } + + @property + def a(self): + """ + An array containing values of the first parameter value + + The 'a' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["a"] + + @a.setter + def a(self, val): + self["a"] = val + + @property + def a0(self): + """ + Alternate to `a`. Builds a linear space of a coordinates. Use + with `da` where `a0` is the starting coordinate and `da` the + step. + + The 'a0' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["a0"] + + @a0.setter + def a0(self, val): + self["a0"] = val + + @property + def aaxis(self): + """ + The 'aaxis' property is an instance of Aaxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.Aaxis` + - A dict of string/value properties that will be passed + to the Aaxis constructor + + Returns + ------- + plotly.graph_objs.carpet.Aaxis + """ + return self["aaxis"] + + @aaxis.setter + def aaxis(self, val): + self["aaxis"] = val + + @property + def asrc(self): + """ + Sets the source reference on Chart Studio Cloud for `a`. + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["asrc"] + + @asrc.setter + def asrc(self, val): + self["asrc"] = val + + @property + def b(self): + """ + A two dimensional array of y coordinates at each carpet point. + + The 'b' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def b0(self): + """ + Alternate to `b`. Builds a linear space of a coordinates. Use + with `db` where `b0` is the starting coordinate and `db` the + step. + + The 'b0' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["b0"] + + @b0.setter + def b0(self, val): + self["b0"] = val + + @property + def baxis(self): + """ + The 'baxis' property is an instance of Baxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.Baxis` + - A dict of string/value properties that will be passed + to the Baxis constructor + + Returns + ------- + plotly.graph_objs.carpet.Baxis + """ + return self["baxis"] + + @baxis.setter + def baxis(self, val): + self["baxis"] = val + + @property + def bsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `b`. + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bsrc"] + + @bsrc.setter + def bsrc(self, val): + self["bsrc"] = val + + @property + def carpet(self): + """ + An identifier for this carpet, so that `scattercarpet` and + `contourcarpet` traces can specify a carpet plot on which they + lie + + The 'carpet' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["carpet"] + + @carpet.setter + def carpet(self, val): + self["carpet"] = val + + @property + def cheaterslope(self): + """ + The shift applied to each successive row of data in creating a + cheater plot. Only used if `x` is been omitted. + + The 'cheaterslope' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cheaterslope"] + + @cheaterslope.setter + def cheaterslope(self, val): + self["cheaterslope"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def da(self): + """ + Sets the a coordinate step. See `a0` for more info. + + The 'da' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["da"] + + @da.setter + def da(self, val): + self["da"] = val + + @property + def db(self): + """ + Sets the b coordinate step. See `b0` for more info. + + The 'db' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["db"] + + @db.setter + def db(self, val): + self["db"] = val + + @property + def font(self): + """ + The default font used for axis & tick labels on this carpet + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.carpet.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.carpet.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.carpet.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + A two dimensional array of x coordinates at each carpet point. + If omitted, the plot is a cheater plot and the xaxis is hidden + by default. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + A two dimensional array of y coordinates at each carpet point. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + a + An array containing values of the first parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the starting + coordinate and `da` the step. + aaxis + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + A two dimensional array of y coordinates at each carpet + point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the starting + coordinate and `db` the step. + baxis + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + cheaterslope + The shift applied to each successive row of data in + creating a cheater plot. Only used if `x` is been + omitted. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the a coordinate step. See `a0` for more info. + db + Sets the b coordinate step. See `b0` for more info. + font + The default font used for axis & tick labels on this + carpet + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.carpet.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + stream + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + A two dimensional array of x coordinates at each carpet + point. If omitted, the plot is a cheater plot and the + xaxis is hidden by default. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + A two dimensional array of y coordinates at each carpet + point. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + a=None, + a0=None, + aaxis=None, + asrc=None, + b=None, + b0=None, + baxis=None, + bsrc=None, + carpet=None, + cheaterslope=None, + color=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + font=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xsrc=None, + y=None, + yaxis=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Carpet object + + The data describing carpet axis layout is set in `y` and + (optionally) also `x`. If only `y` is present, `x` the plot is + interpreted as a cheater plot and is filled in using the `y` + values. `x` and `y` may either be 2D arrays matching with each + dimension matching that of `a` and `b`, or they may be 1D + arrays with total length equal to that of `a` and `b`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Carpet` + a + An array containing values of the first parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the starting + coordinate and `da` the step. + aaxis + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + A two dimensional array of y coordinates at each carpet + point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the starting + coordinate and `db` the step. + baxis + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + cheaterslope + The shift applied to each successive row of data in + creating a cheater plot. Only used if `x` is been + omitted. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the a coordinate step. See `a0` for more info. + db + Sets the b coordinate step. See `b0` for more info. + font + The default font used for axis & tick labels on this + carpet + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.carpet.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + stream + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + A two dimensional array of x coordinates at each carpet + point. If omitted, the plot is a cheater plot and the + xaxis is hidden by default. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + A two dimensional array of y coordinates at each carpet + point. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Carpet + """ + super().__init__("carpet") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Carpet +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Carpet`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("a", arg, a) + self._set_property("a0", arg, a0) + self._set_property("aaxis", arg, aaxis) + self._set_property("asrc", arg, asrc) + self._set_property("b", arg, b) + self._set_property("b0", arg, b0) + self._set_property("baxis", arg, baxis) + self._set_property("bsrc", arg, bsrc) + self._set_property("carpet", arg, carpet) + self._set_property("cheaterslope", arg, cheaterslope) + self._set_property("color", arg, color) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("da", arg, da) + self._set_property("db", arg, db) + self._set_property("font", arg, font) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("stream", arg, stream) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xaxis", arg, xaxis) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yaxis", arg, yaxis) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "carpet" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_choropleth.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_choropleth.py new file mode 100644 index 0000000..9c55f8a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_choropleth.py @@ -0,0 +1,1755 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Choropleth(_BaseTraceType): + _parent_path_str = "" + _path_str = "choropleth" + _valid_props = { + "autocolorscale", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "featureidkey", + "geo", + "geojson", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "locationmode", + "locations", + "locationssrc", + "marker", + "meta", + "metasrc", + "name", + "reversescale", + "selected", + "selectedpoints", + "showlegend", + "showscale", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "z", + "zauto", + "zmax", + "zmid", + "zmin", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.choropleth.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def featureidkey(self): + """ + Sets the key in GeoJSON features which is used as id to match + the items included in the `locations` array. Only has an effect + when `geojson` is set. Support nested property, for example + "properties.name". + + The 'featureidkey' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["featureidkey"] + + @featureidkey.setter + def featureidkey(self, val): + self["featureidkey"] = val + + @property + def geo(self): + """ + Sets a reference between this trace's geospatial coordinates + and a geographic map. If "geo" (the default value), the + geospatial coordinates refer to `layout.geo`. If "geo2", the + geospatial coordinates refer to `layout.geo2`, and so on. + + The 'geo' property is an identifier of a particular + subplot, of type 'geo', that may be specified as the string 'geo' + optionally followed by an integer >= 1 + (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) + + Returns + ------- + str + """ + return self["geo"] + + @geo.setter + def geo(self, val): + self["geo"] = val + + @property + def geojson(self): + """ + 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". + + The 'geojson' property accepts values of any type + + Returns + ------- + Any + """ + return self["geojson"] + + @geojson.setter + def geojson(self, val): + self["geojson"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'location+z') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.choropleth.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.choropleth.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def locationmode(self): + """ + Determines the set of locations used to match entries in + `locations` 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 `geojson` attribute. + + The 'locationmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['ISO-3', 'USA-states', 'country names', 'geojson-id'] + + Returns + ------- + Any + """ + return self["locationmode"] + + @locationmode.setter + def locationmode(self, val): + self["locationmode"] = val + + @property + def locations(self): + """ + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choropleth.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.choropleth.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.choropleth.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each location. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.choropleth.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def z(self): + """ + Sets the color values. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choropleth.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + 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, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + ): + """ + Construct a new Choropleth object + + The data that describes the choropleth value-to-color mapping + is set in `z`. The geographic locations corresponding to each + value in `z` are set in `locations`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Choropleth` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choropleth.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Choropleth + """ + super().__init__("choropleth") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Choropleth +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Choropleth`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("featureidkey", arg, featureidkey) + self._set_property("geo", arg, geo) + self._set_property("geojson", arg, geojson) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("locationmode", arg, locationmode) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("reversescale", arg, reversescale) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "choropleth" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmap.py new file mode 100644 index 0000000..7c23376 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmap.py @@ -0,0 +1,1749 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Choroplethmap(_BaseTraceType): + _parent_path_str = "" + _path_str = "choroplethmap" + _valid_props = { + "autocolorscale", + "below", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "featureidkey", + "geojson", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "locations", + "locationssrc", + "marker", + "meta", + "metasrc", + "name", + "reversescale", + "selected", + "selectedpoints", + "showlegend", + "showscale", + "stream", + "subplot", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "z", + "zauto", + "zmax", + "zmid", + "zmin", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def below(self): + """ + Determines if the choropleth polygons will be inserted before + the layer with the specified ID. By default, choroplethmap + traces are placed above the water layers. If set to '', the + layer will be inserted above every existing layer. + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def featureidkey(self): + """ + Sets the key in GeoJSON features which is used as id to match + the items included in the `locations` array. Support nested + property, for example "properties.name". + + The 'featureidkey' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["featureidkey"] + + @featureidkey.setter + def featureidkey(self, val): + self["featureidkey"] = val + + @property + def geojson(self): + """ + Sets the GeoJSON data associated with this trace. 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". + + The 'geojson' property accepts values of any type + + Returns + ------- + Any + """ + return self["geojson"] + + @geojson.setter + def geojson(self, val): + self["geojson"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'location+z') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variable `properties` Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def locations(self): + """ + Sets which features found in "geojson" to plot using their + feature `id` field. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + map subplot. If "map" (the default value), the data refer to + `layout.map`. If "map2", the data refer to `layout.map2`, and + so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'map', that may be specified as the string 'map' + optionally followed by an integer >= 1 + (e.g. 'map', 'map1', 'map2', 'map3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets the text elements associated with each location. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def z(self): + """ + Sets the color values. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmap traces are placed above the water layers. + If set to '', the layer will be inserted above every + existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmap.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmap.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + subplot=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, + ): + """ + Construct a new Choroplethmap object + + GeoJSON features to be filled are set in `geojson` The data + that describes the choropleth value-to-color mapping is set in + `locations` and `z`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Choroplethmap` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmap traces are placed above the water layers. + If set to '', the layer will be inserted above every + existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmap.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmap.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Choroplethmap + """ + super().__init__("choroplethmap") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Choroplethmap +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Choroplethmap`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("below", arg, below) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("featureidkey", arg, featureidkey) + self._set_property("geojson", arg, geojson) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("reversescale", arg, reversescale) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "choroplethmap" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmapbox.py new file mode 100644 index 0000000..8225c27 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_choroplethmapbox.py @@ -0,0 +1,1777 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy +import warnings + + +class Choroplethmapbox(_BaseTraceType): + _parent_path_str = "" + _path_str = "choroplethmapbox" + _valid_props = { + "autocolorscale", + "below", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "featureidkey", + "geojson", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "locations", + "locationssrc", + "marker", + "meta", + "metasrc", + "name", + "reversescale", + "selected", + "selectedpoints", + "showlegend", + "showscale", + "stream", + "subplot", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "z", + "zauto", + "zmax", + "zmid", + "zmin", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def below(self): + """ + Determines if the choropleth polygons will be inserted before + the layer with the specified ID. By default, choroplethmapbox + traces are placed above the water layers. If set to '', the + layer will be inserted above every existing layer. + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def featureidkey(self): + """ + Sets the key in GeoJSON features which is used as id to match + the items included in the `locations` array. Support nested + property, for example "properties.name". + + The 'featureidkey' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["featureidkey"] + + @featureidkey.setter + def featureidkey(self, val): + self["featureidkey"] = val + + @property + def geojson(self): + """ + Sets the GeoJSON data associated with this trace. 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". + + The 'geojson' property accepts values of any type + + Returns + ------- + Any + """ + return self["geojson"] + + @geojson.setter + def geojson(self, val): + self["geojson"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['location', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'location+z') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variable `properties` Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def locations(self): + """ + Sets which features found in "geojson" to plot using their + feature `id` field. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + mapbox subplots and traces are deprecated! Please consider + switching to `map` subplots and traces. Learn more at: + https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ Sets a + reference between this trace's data coordinates and a mapbox + subplot. If "mapbox" (the default value), the data refer to + `layout.mapbox`. If "mapbox2", the data refer to + `layout.mapbox2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'mapbox', that may be specified as the string 'mapbox' + optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets the text elements associated with each location. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def z(self): + """ + Sets the color values. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmapbox traces are placed above the water + layers. If set to '', the layer will be inserted above + every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmapbox.Legendgro + uptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + subplot=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, + ): + """ + Construct a new Choroplethmapbox object + + "choroplethmapbox" trace is deprecated! Please consider + switching to the "choroplethmap" trace type and `map` subplots. + Learn more at: https://plotly.com/python/maplibre-migration/ as + well as https://plotly.com/javascript/maplibre-migration/ + GeoJSON features to be filled are set in `geojson` The data + that describes the choropleth value-to-color mapping is set in + `locations` and `z`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.Choroplethmapbox` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmapbox traces are placed above the water + layers. If set to '', the layer will be inserted above + every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmapbox.Legendgro + uptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Choroplethmapbox + """ + super().__init__("choroplethmapbox") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Choroplethmapbox +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Choroplethmapbox`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("below", arg, below) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("featureidkey", arg, featureidkey) + self._set_property("geojson", arg, geojson) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("reversescale", arg, reversescale) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "choroplethmapbox" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False + + warnings.warn( + "*choroplethmapbox* is deprecated!" + + " Use *choroplethmap* instead." + + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/", + stacklevel=2, + category=DeprecationWarning, + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_cone.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_cone.py new file mode 100644 index 0000000..0e85f56 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_cone.py @@ -0,0 +1,2260 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Cone(_BaseTraceType): + _parent_path_str = "" + _path_str = "cone" + _valid_props = { + "anchor", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lighting", + "lightposition", + "meta", + "metasrc", + "name", + "opacity", + "reversescale", + "scene", + "showlegend", + "showscale", + "sizemode", + "sizeref", + "stream", + "text", + "textsrc", + "type", + "u", + "uhoverformat", + "uid", + "uirevision", + "usrc", + "v", + "vhoverformat", + "visible", + "vsrc", + "w", + "whoverformat", + "wsrc", + "x", + "xhoverformat", + "xsrc", + "y", + "yhoverformat", + "ysrc", + "z", + "zhoverformat", + "zsrc", + } + + @property + def anchor(self): + """ + Sets the cones' anchor with respect to their x/y/z positions. + Note that "cm" denote the cone's center of mass which + corresponds to 1/4 from the tail to tip. + + The 'anchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['tip', 'tail', 'cm', 'center'] + + Returns + ------- + Any + """ + return self["anchor"] + + @anchor.setter + def anchor(self, val): + self["anchor"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here u/v/w norm) or the bounds set + in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` + are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as u/v/w norm and if set, `cmin` must be set as + well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as u/v/w norm. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as u/v/w norm and if set, `cmax` must be set as + well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.cone.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.cone.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variable `norm` Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.cone.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.Lighting` + - A dict of string/value properties that will be passed + to the Lighting constructor + + Returns + ------- + plotly.graph_objs.cone.Lighting + """ + return self["lighting"] + + @lighting.setter + def lighting(self, val): + self["lighting"] = val + + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.Lightposition` + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Returns + ------- + plotly.graph_objs.cone.Lightposition + """ + return self["lightposition"] + + @lightposition.setter + def lightposition(self, val): + self["lightposition"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def sizemode(self): + """ + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in the + vector field) or as "absolute" value (in the same units as the + vector field). To display sizes in actual vector length use + "raw". + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['scaled', 'absolute', 'raw'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) corresponds to the + minimum "time" to travel across two successive x/y/z positions + at the average velocity of those two successive positions. All + cones in a given trace use the same factor. With `sizemode` set + to "raw", its default value is 1. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is 0.5. With + `sizemode` set to "absolute", `sizeref` has the same units as + the u/v/w vector field, its the default value is half the + sample's maximum vector norm. + + The 'sizeref' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.cone.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with the cones. If trace + `hoverinfo` contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def u(self): + """ + Sets the x components of the vector field. + + The 'u' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["u"] + + @u.setter + def u(self, val): + self["u"] = val + + @property + def uhoverformat(self): + """ + Sets the hover text formatting rulefor `u` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'uhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uhoverformat"] + + @uhoverformat.setter + def uhoverformat(self, val): + self["uhoverformat"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def usrc(self): + """ + Sets the source reference on Chart Studio Cloud for `u`. + + The 'usrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["usrc"] + + @usrc.setter + def usrc(self, val): + self["usrc"] = val + + @property + def v(self): + """ + Sets the y components of the vector field. + + The 'v' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["v"] + + @v.setter + def v(self, val): + self["v"] = val + + @property + def vhoverformat(self): + """ + Sets the hover text formatting rulefor `v` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'vhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["vhoverformat"] + + @vhoverformat.setter + def vhoverformat(self, val): + self["vhoverformat"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def vsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `v`. + + The 'vsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["vsrc"] + + @vsrc.setter + def vsrc(self, val): + self["vsrc"] = val + + @property + def w(self): + """ + Sets the z components of the vector field. + + The 'w' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["w"] + + @w.setter + def w(self, val): + self["w"] = val + + @property + def whoverformat(self): + """ + Sets the hover text formatting rulefor `w` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'whoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["whoverformat"] + + @whoverformat.setter + def whoverformat(self, val): + self["whoverformat"] = val + + @property + def wsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `w`. + + The 'wsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["wsrc"] + + @wsrc.setter + def wsrc(self, val): + self["wsrc"] = val + + @property + def x(self): + """ + Sets the x coordinates of the vector field and of the displayed + cones. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates of the vector field and of the displayed + cones. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the z coordinates of the vector field and of the displayed + cones. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + anchor + Sets the cones' anchor with respect to their x/y/z + positions. Note that "cm" denote the cone's center of + mass which corresponds to 1/4 from the tail to tip. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `norm` Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.cone.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.cone.Lighting` instance or + dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizemode + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in + the vector field) or as "absolute" value (in the same + units as the vector field). To display sizes in actual + vector length use "raw". + sizeref + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) + corresponds to the minimum "time" to travel across two + successive x/y/z positions at the average velocity of + those two successive positions. All cones in a given + trace use the same factor. With `sizemode` set to + "raw", its default value is 1. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is + 0.5. With `sizemode` set to "absolute", `sizeref` has + the same units as the u/v/w vector field, its the + default value is half the sample's maximum vector norm. + stream + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the cones. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field and of the + displayed cones. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field and of the + displayed cones. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field and of the + displayed cones. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + anchor=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + sizemode=None, + sizeref=None, + stream=None, + text=None, + textsrc=None, + u=None, + uhoverformat=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + vhoverformat=None, + visible=None, + vsrc=None, + w=None, + whoverformat=None, + wsrc=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Cone object + + Use cone traces to visualize vector fields. Specify a vector + field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and + 3 vector component arrays `u`, `v`, `w`. The cones are drawn + exactly at the positions given by `x`, `y` and `z`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Cone` + anchor + Sets the cones' anchor with respect to their x/y/z + positions. Note that "cm" denote the cone's center of + mass which corresponds to 1/4 from the tail to tip. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `norm` Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.cone.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.cone.Lighting` instance or + dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizemode + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in + the vector field) or as "absolute" value (in the same + units as the vector field). To display sizes in actual + vector length use "raw". + sizeref + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) + corresponds to the minimum "time" to travel across two + successive x/y/z positions at the average velocity of + those two successive positions. All cones in a given + trace use the same factor. With `sizemode` set to + "raw", its default value is 1. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is + 0.5. With `sizemode` set to "absolute", `sizeref` has + the same units as the u/v/w vector field, its the + default value is half the sample's maximum vector norm. + stream + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the cones. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field and of the + displayed cones. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field and of the + displayed cones. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field and of the + displayed cones. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Cone + """ + super().__init__("cone") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Cone +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Cone`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("anchor", arg, anchor) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lighting", arg, lighting) + self._set_property("lightposition", arg, lightposition) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("u", arg, u) + self._set_property("uhoverformat", arg, uhoverformat) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("usrc", arg, usrc) + self._set_property("v", arg, v) + self._set_property("vhoverformat", arg, vhoverformat) + self._set_property("visible", arg, visible) + self._set_property("vsrc", arg, vsrc) + self._set_property("w", arg, w) + self._set_property("whoverformat", arg, whoverformat) + self._set_property("wsrc", arg, wsrc) + self._set_property("x", arg, x) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "cone" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_contour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_contour.py new file mode 100644 index 0000000..3d4eb5c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_contour.py @@ -0,0 +1,2616 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Contour(_BaseTraceType): + _parent_path_str = "" + _path_str = "contour" + _valid_props = { + "autocolorscale", + "autocontour", + "coloraxis", + "colorbar", + "colorscale", + "connectgaps", + "contours", + "customdata", + "customdatasrc", + "dx", + "dy", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoverongaps", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "meta", + "metasrc", + "name", + "ncontours", + "opacity", + "reversescale", + "showlegend", + "showscale", + "stream", + "text", + "textfont", + "textsrc", + "texttemplate", + "transpose", + "type", + "uid", + "uirevision", + "visible", + "x", + "x0", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "xtype", + "y", + "y0", + "yaxis", + "ycalendar", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "ytype", + "z", + "zauto", + "zhoverformat", + "zmax", + "zmid", + "zmin", + "zorder", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def autocontour(self): + """ + Determines whether or not the contour level attributes are + picked by an algorithm. If True, the number of contour levels + can be set in `ncontours`. If False, set the contour level + attributes in `contours`. + + The 'autocontour' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocontour"] + + @autocontour.setter + def autocontour(self, val): + self["autocontour"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.contour.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the `z` data are filled in. It is defaulted to true if `z` + is a one dimensional array otherwise it is defaulted to false. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.Contours` + - A dict of string/value properties that will be passed + to the Contours constructor + + Returns + ------- + plotly.graph_objs.contour.Contours + """ + return self["contours"] + + @contours.setter + def contours(self, val): + self["contours"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def fillcolor(self): + """ + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line color, + marker color, or marker line color, whichever is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to contour.colorscale + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.contour.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoverongaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the `z` data have hover labels associated with them. + + The 'hoverongaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["hoverongaps"] + + @hoverongaps.setter + def hoverongaps(self, val): + self["hoverongaps"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.contour.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.contour.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def ncontours(self): + """ + Sets the maximum number of contour levels. The actual number of + contours will be chosen automatically to be less than or equal + to the value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is missing. + + The 'ncontours' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ncontours"] + + @ncontours.setter + def ncontours(self, val): + self["ncontours"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.contour.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each z value. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + For this trace it only has an effect if `coloring` is set to + "heatmap". Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.contour.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + For this trace it only has an effect if `coloring` is set to + "heatmap". Template string used for rendering the information + text that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `x`, `y`, + `z` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["transpose"] + + @transpose.setter + def transpose(self, val): + self["transpose"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def xtype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'xtype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self["xtype"] + + @xtype.setter + def xtype(self, val): + self["xtype"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def ytype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'ytype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self["ytype"] + + @ytype.setter + def ytype(self, val): + self["ytype"] = val + + @property + def z(self): + """ + Sets the z data. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array otherwise it + is defaulted to false. + contours + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contour.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + autocontour=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoverongaps=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textfont=None, + textsrc=None, + texttemplate=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Contour object + + The data from which contour lines are computed is set in `z`. + Data in `z` must be a 2D list of numbers. Say that `z` has N + rows and M columns, then by default, these N rows correspond to + N y coordinates (set in `y` or auto-generated) and the M + columns correspond to M x coordinates (set in `x` or auto- + generated). By setting `transpose` to True, the above behavior + is flipped. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Contour` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array otherwise it + is defaulted to false. + contours + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contour.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Contour + """ + super().__init__("contour") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Contour +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Contour`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("autocontour", arg, autocontour) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("contours", arg, contours) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoverongaps", arg, hoverongaps) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("ncontours", arg, ncontours) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("transpose", arg, transpose) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("xtype", arg, xtype) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("ytype", arg, ytype) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zorder", arg, zorder) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "contour" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_contourcarpet.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_contourcarpet.py new file mode 100644 index 0000000..2a24b88 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_contourcarpet.py @@ -0,0 +1,1837 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Contourcarpet(_BaseTraceType): + _parent_path_str = "" + _path_str = "contourcarpet" + _valid_props = { + "a", + "a0", + "asrc", + "atype", + "autocolorscale", + "autocontour", + "b", + "b0", + "bsrc", + "btype", + "carpet", + "coloraxis", + "colorbar", + "colorscale", + "contours", + "customdata", + "customdatasrc", + "da", + "db", + "fillcolor", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "meta", + "metasrc", + "name", + "ncontours", + "opacity", + "reversescale", + "showlegend", + "showscale", + "stream", + "text", + "textsrc", + "transpose", + "type", + "uid", + "uirevision", + "visible", + "xaxis", + "yaxis", + "z", + "zauto", + "zmax", + "zmid", + "zmin", + "zorder", + "zsrc", + } + + @property + def a(self): + """ + Sets the x coordinates. + + The 'a' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["a"] + + @a.setter + def a(self, val): + self["a"] = val + + @property + def a0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'a0' property accepts values of any type + + Returns + ------- + Any + """ + return self["a0"] + + @a0.setter + def a0(self, val): + self["a0"] = val + + @property + def asrc(self): + """ + Sets the source reference on Chart Studio Cloud for `a`. + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["asrc"] + + @asrc.setter + def asrc(self, val): + self["asrc"] = val + + @property + def atype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'atype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self["atype"] + + @atype.setter + def atype(self, val): + self["atype"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def autocontour(self): + """ + Determines whether or not the contour level attributes are + picked by an algorithm. If True, the number of contour levels + can be set in `ncontours`. If False, set the contour level + attributes in `contours`. + + The 'autocontour' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocontour"] + + @autocontour.setter + def autocontour(self, val): + self["autocontour"] = val + + @property + def b(self): + """ + Sets the y coordinates. + + The 'b' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def b0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'b0' property accepts values of any type + + Returns + ------- + Any + """ + return self["b0"] + + @b0.setter + def b0(self, val): + self["b0"] = val + + @property + def bsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `b`. + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bsrc"] + + @bsrc.setter + def bsrc(self, val): + self["bsrc"] = val + + @property + def btype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'btype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self["btype"] + + @btype.setter + def btype(self, val): + self["btype"] = val + + @property + def carpet(self): + """ + The `carpet` of the carpet axes on which this contour trace + lies + + The 'carpet' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["carpet"] + + @carpet.setter + def carpet(self, val): + self["carpet"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.Contours` + - A dict of string/value properties that will be passed + to the Contours constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.Contours + """ + return self["contours"] + + @contours.setter + def contours(self, val): + self["contours"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def da(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'da' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["da"] + + @da.setter + def da(self, val): + self["da"] = val + + @property + def db(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'db' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["db"] + + @db.setter + def db(self, val): + self["db"] = val + + @property + def fillcolor(self): + """ + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line color, + marker color, or marker line color, whichever is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to contourcarpet.colorscale + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def ncontours(self): + """ + Sets the maximum number of contour levels. The actual number of + contours will be chosen automatically to be less than or equal + to the value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is missing. + + The 'ncontours' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ncontours"] + + @ncontours.setter + def ncontours(self, val): + self["ncontours"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each z value. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["transpose"] + + @transpose.setter + def transpose(self, val): + self["transpose"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def z(self): + """ + Sets the z data. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + atype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + btype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + carpet + The `carpet` of the carpet axes on which this contour + trace lies + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the x coordinate step. See `x0` for more info. + db + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contourcarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + a=None, + a0=None, + asrc=None, + atype=None, + autocolorscale=None, + autocontour=None, + b=None, + b0=None, + bsrc=None, + btype=None, + carpet=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + fillcolor=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + xaxis=None, + yaxis=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Contourcarpet object + + Plots contours on either the first carpet axis or the carpet + axis with a matching `carpet` attribute. Data `z` is + interpreted as matching that of the corresponding carpet axis. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Contourcarpet` + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + atype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + btype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + carpet + The `carpet` of the carpet axes on which this contour + trace lies + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the x coordinate step. See `x0` for more info. + db + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contourcarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Contourcarpet + """ + super().__init__("contourcarpet") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Contourcarpet +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Contourcarpet`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("a", arg, a) + self._set_property("a0", arg, a0) + self._set_property("asrc", arg, asrc) + self._set_property("atype", arg, atype) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("autocontour", arg, autocontour) + self._set_property("b", arg, b) + self._set_property("b0", arg, b0) + self._set_property("bsrc", arg, bsrc) + self._set_property("btype", arg, btype) + self._set_property("carpet", arg, carpet) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("contours", arg, contours) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("da", arg, da) + self._set_property("db", arg, db) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("ncontours", arg, ncontours) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("transpose", arg, transpose) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("xaxis", arg, xaxis) + self._set_property("yaxis", arg, yaxis) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zorder", arg, zorder) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "contourcarpet" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymap.py new file mode 100644 index 0000000..4291849 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymap.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Densitymap(_BaseTraceType): + _parent_path_str = "" + _path_str = "densitymap" + _valid_props = { + "autocolorscale", + "below", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "lat", + "latsrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lon", + "lonsrc", + "meta", + "metasrc", + "name", + "opacity", + "radius", + "radiussrc", + "reversescale", + "showlegend", + "showscale", + "stream", + "subplot", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "visible", + "z", + "zauto", + "zmax", + "zmid", + "zmin", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def below(self): + """ + Determines if the densitymap trace will be inserted before the + layer with the specified ID. By default, densitymap traces are + placed below the first layer of type symbol If set to '', the + layer will be inserted above every existing layer. + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.densitymap.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.densitymap.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def lat(self): + """ + Sets the latitude coordinates (in degrees North). + + The 'lat' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def latsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lat`. + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["latsrc"] + + @latsrc.setter + def latsrc(self, val): + self["latsrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.densitymap.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lon(self): + """ + Sets the longitude coordinates (in degrees East). + + The 'lon' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def lonsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lon`. + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lonsrc"] + + @lonsrc.setter + def lonsrc(self, val): + self["lonsrc"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def radius(self): + """ + Sets the radius of influence of one `lon` / `lat` point in + pixels. Increasing the value makes the densitymap trace + smoother, but less detailed. + + The 'radius' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["radius"] + + @radius.setter + def radius(self, val): + self["radius"] = val + + @property + def radiussrc(self): + """ + Sets the source reference on Chart Studio Cloud for `radius`. + + The 'radiussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["radiussrc"] + + @radiussrc.setter + def radiussrc(self, val): + self["radiussrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.densitymap.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + map subplot. If "map" (the default value), the data refer to + `layout.map`. If "map2", the data refer to `layout.map2`, and + so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'map', that may be specified as the string 'map' + optionally followed by an integer >= 1 + (e.g. 'map', 'map1', 'map2', 'map3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def z(self): + """ + Sets the points' weight. For example, a value of 10 would be + equivalent to having 10 points of weight 1 in the same spot + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymap trace will be inserted + before the layer with the specified ID. By default, + densitymap traces are placed below the first layer of + type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymap + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lon=None, + lonsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + radius=None, + radiussrc=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Densitymap object + + Draws a bivariate kernel density estimation with a Gaussian + kernel from `lon` and `lat` coordinates and optional `z` values + using a colorscale. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Densitymap` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymap trace will be inserted + before the layer with the specified ID. By default, + densitymap traces are placed below the first layer of + type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymap + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Densitymap + """ + super().__init__("densitymap") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Densitymap +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Densitymap`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("below", arg, below) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("lat", arg, lat) + self._set_property("latsrc", arg, latsrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lon", arg, lon) + self._set_property("lonsrc", arg, lonsrc) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("radius", arg, radius) + self._set_property("radiussrc", arg, radiussrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "densitymap" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymapbox.py new file mode 100644 index 0000000..e483328 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_densitymapbox.py @@ -0,0 +1,1749 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy +import warnings + + +class Densitymapbox(_BaseTraceType): + _parent_path_str = "" + _path_str = "densitymapbox" + _valid_props = { + "autocolorscale", + "below", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "lat", + "latsrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lon", + "lonsrc", + "meta", + "metasrc", + "name", + "opacity", + "radius", + "radiussrc", + "reversescale", + "showlegend", + "showscale", + "stream", + "subplot", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "visible", + "z", + "zauto", + "zmax", + "zmid", + "zmin", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def below(self): + """ + Determines if the densitymapbox trace will be inserted before + the layer with the specified ID. By default, densitymapbox + traces are placed below the first layer of type symbol If set + to '', the layer will be inserted above every existing layer. + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lon', 'lat', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def lat(self): + """ + Sets the latitude coordinates (in degrees North). + + The 'lat' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def latsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lat`. + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["latsrc"] + + @latsrc.setter + def latsrc(self, val): + self["latsrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lon(self): + """ + Sets the longitude coordinates (in degrees East). + + The 'lon' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def lonsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lon`. + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lonsrc"] + + @lonsrc.setter + def lonsrc(self, val): + self["lonsrc"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def radius(self): + """ + Sets the radius of influence of one `lon` / `lat` point in + pixels. Increasing the value makes the densitymapbox trace + smoother, but less detailed. + + The 'radius' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["radius"] + + @radius.setter + def radius(self, val): + self["radius"] = val + + @property + def radiussrc(self): + """ + Sets the source reference on Chart Studio Cloud for `radius`. + + The 'radiussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["radiussrc"] + + @radiussrc.setter + def radiussrc(self, val): + self["radiussrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + mapbox subplots and traces are deprecated! Please consider + switching to `map` subplots and traces. Learn more at: + https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ Sets a + reference between this trace's data coordinates and a mapbox + subplot. If "mapbox" (the default value), the data refer to + `layout.mapbox`. If "mapbox2", the data refer to + `layout.mapbox2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'mapbox', that may be specified as the string 'mapbox' + optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def z(self): + """ + Sets the points' weight. For example, a value of 10 would be + equivalent to having 10 points of weight 1 in the same spot + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymapbox trace will be inserted + before the layer with the specified ID. By default, + densitymapbox traces are placed below the first layer + of type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymapbox + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lon=None, + lonsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + radius=None, + radiussrc=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Densitymapbox object + + "densitymapbox" trace is deprecated! Please consider switching + to the "densitymap" trace type and `map` subplots. Learn more + at: https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ Draws a + bivariate kernel density estimation with a Gaussian kernel from + `lon` and `lat` coordinates and optional `z` values using a + colorscale. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Densitymapbox` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymapbox trace will be inserted + before the layer with the specified ID. By default, + densitymapbox traces are placed below the first layer + of type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymapbox + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Densitymapbox + """ + super().__init__("densitymapbox") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Densitymapbox +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Densitymapbox`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("below", arg, below) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("lat", arg, lat) + self._set_property("latsrc", arg, latsrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lon", arg, lon) + self._set_property("lonsrc", arg, lonsrc) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("radius", arg, radius) + self._set_property("radiussrc", arg, radiussrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "densitymapbox" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False + + warnings.warn( + "*densitymapbox* is deprecated!" + + " Use *densitymap* instead." + + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/", + stacklevel=2, + category=DeprecationWarning, + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_deprecations.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_deprecations.py new file mode 100644 index 0000000..aa08325 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_deprecations.py @@ -0,0 +1,723 @@ +import warnings + +warnings.filterwarnings( + "default", r"plotly\.graph_objs\.\w+ is deprecated", DeprecationWarning +) + + +class Data(list): + """ + plotly.graph_objs.Data is deprecated. + Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.Scatter + - plotly.graph_objs.Bar + - plotly.graph_objs.Area + - plotly.graph_objs.Histogram + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Data is deprecated. + Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.Scatter + - plotly.graph_objs.Bar + - plotly.graph_objs.Area + - plotly.graph_objs.Histogram + - etc. + + """ + warnings.warn( + """plotly.graph_objs.Data is deprecated. +Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.Scatter + - plotly.graph_objs.Bar + - plotly.graph_objs.Area + - plotly.graph_objs.Histogram + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Annotations(list): + """ + plotly.graph_objs.Annotations is deprecated. + Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.layout.Annotation + - plotly.graph_objs.layout.scene.Annotation + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Annotations is deprecated. + Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.layout.Annotation + - plotly.graph_objs.layout.scene.Annotation + + """ + warnings.warn( + """plotly.graph_objs.Annotations is deprecated. +Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.layout.Annotation + - plotly.graph_objs.layout.scene.Annotation +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Frames(list): + """ + plotly.graph_objs.Frames is deprecated. + Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.Frame + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Frames is deprecated. + Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.Frame + + """ + warnings.warn( + """plotly.graph_objs.Frames is deprecated. +Please replace it with a list or tuple of instances of the following types + - plotly.graph_objs.Frame +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class AngularAxis(dict): + """ + plotly.graph_objs.AngularAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.AngularAxis + - plotly.graph_objs.layout.polar.AngularAxis + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.AngularAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.AngularAxis + - plotly.graph_objs.layout.polar.AngularAxis + + """ + warnings.warn( + """plotly.graph_objs.AngularAxis is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.AngularAxis + - plotly.graph_objs.layout.polar.AngularAxis +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Annotation(dict): + """ + plotly.graph_objs.Annotation is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Annotation + - plotly.graph_objs.layout.scene.Annotation + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Annotation is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Annotation + - plotly.graph_objs.layout.scene.Annotation + + """ + warnings.warn( + """plotly.graph_objs.Annotation is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Annotation + - plotly.graph_objs.layout.scene.Annotation +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class ColorBar(dict): + """ + plotly.graph_objs.ColorBar is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.marker.ColorBar + - plotly.graph_objs.surface.ColorBar + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.ColorBar is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.marker.ColorBar + - plotly.graph_objs.surface.ColorBar + - etc. + + """ + warnings.warn( + """plotly.graph_objs.ColorBar is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.marker.ColorBar + - plotly.graph_objs.surface.ColorBar + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Contours(dict): + """ + plotly.graph_objs.Contours is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.contour.Contours + - plotly.graph_objs.surface.Contours + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Contours is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.contour.Contours + - plotly.graph_objs.surface.Contours + - etc. + + """ + warnings.warn( + """plotly.graph_objs.Contours is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.contour.Contours + - plotly.graph_objs.surface.Contours + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class ErrorX(dict): + """ + plotly.graph_objs.ErrorX is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.ErrorX + - plotly.graph_objs.histogram.ErrorX + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.ErrorX is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.ErrorX + - plotly.graph_objs.histogram.ErrorX + - etc. + + """ + warnings.warn( + """plotly.graph_objs.ErrorX is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.ErrorX + - plotly.graph_objs.histogram.ErrorX + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class ErrorY(dict): + """ + plotly.graph_objs.ErrorY is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.ErrorY + - plotly.graph_objs.histogram.ErrorY + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.ErrorY is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.ErrorY + - plotly.graph_objs.histogram.ErrorY + - etc. + + """ + warnings.warn( + """plotly.graph_objs.ErrorY is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.ErrorY + - plotly.graph_objs.histogram.ErrorY + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class ErrorZ(dict): + """ + plotly.graph_objs.ErrorZ is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter3d.ErrorZ + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.ErrorZ is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter3d.ErrorZ + + """ + warnings.warn( + """plotly.graph_objs.ErrorZ is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter3d.ErrorZ +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Font(dict): + """ + plotly.graph_objs.Font is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Font + - plotly.graph_objs.layout.hoverlabel.Font + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Font is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Font + - plotly.graph_objs.layout.hoverlabel.Font + - etc. + + """ + warnings.warn( + """plotly.graph_objs.Font is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Font + - plotly.graph_objs.layout.hoverlabel.Font + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Legend(dict): + """ + plotly.graph_objs.Legend is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Legend + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Legend is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Legend + + """ + warnings.warn( + """plotly.graph_objs.Legend is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Legend +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Line(dict): + """ + plotly.graph_objs.Line is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Line + - plotly.graph_objs.layout.shape.Line + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Line is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Line + - plotly.graph_objs.layout.shape.Line + - etc. + + """ + warnings.warn( + """plotly.graph_objs.Line is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Line + - plotly.graph_objs.layout.shape.Line + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Margin(dict): + """ + plotly.graph_objs.Margin is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Margin + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Margin is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Margin + + """ + warnings.warn( + """plotly.graph_objs.Margin is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Margin +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Marker(dict): + """ + plotly.graph_objs.Marker is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Marker + - plotly.graph_objs.histogram.selected.Marker + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Marker is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Marker + - plotly.graph_objs.histogram.selected.Marker + - etc. + + """ + warnings.warn( + """plotly.graph_objs.Marker is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Marker + - plotly.graph_objs.histogram.selected.Marker + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class RadialAxis(dict): + """ + plotly.graph_objs.RadialAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.RadialAxis + - plotly.graph_objs.layout.polar.RadialAxis + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.RadialAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.RadialAxis + - plotly.graph_objs.layout.polar.RadialAxis + + """ + warnings.warn( + """plotly.graph_objs.RadialAxis is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.RadialAxis + - plotly.graph_objs.layout.polar.RadialAxis +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Scene(dict): + """ + plotly.graph_objs.Scene is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Scene + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Scene is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Scene + + """ + warnings.warn( + """plotly.graph_objs.Scene is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.Scene +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Stream(dict): + """ + plotly.graph_objs.Stream is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Stream + - plotly.graph_objs.area.Stream + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Stream is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Stream + - plotly.graph_objs.area.Stream + + """ + warnings.warn( + """plotly.graph_objs.Stream is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.scatter.Stream + - plotly.graph_objs.area.Stream +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class XAxis(dict): + """ + plotly.graph_objs.XAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.XAxis + - plotly.graph_objs.layout.scene.XAxis + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.XAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.XAxis + - plotly.graph_objs.layout.scene.XAxis + + """ + warnings.warn( + """plotly.graph_objs.XAxis is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.XAxis + - plotly.graph_objs.layout.scene.XAxis +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class YAxis(dict): + """ + plotly.graph_objs.YAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.YAxis + - plotly.graph_objs.layout.scene.YAxis + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.YAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.YAxis + - plotly.graph_objs.layout.scene.YAxis + + """ + warnings.warn( + """plotly.graph_objs.YAxis is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.YAxis + - plotly.graph_objs.layout.scene.YAxis +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class ZAxis(dict): + """ + plotly.graph_objs.ZAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.scene.ZAxis + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.ZAxis is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.layout.scene.ZAxis + + """ + warnings.warn( + """plotly.graph_objs.ZAxis is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.layout.scene.ZAxis +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class XBins(dict): + """ + plotly.graph_objs.XBins is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.histogram.XBins + - plotly.graph_objs.histogram2d.XBins + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.XBins is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.histogram.XBins + - plotly.graph_objs.histogram2d.XBins + + """ + warnings.warn( + """plotly.graph_objs.XBins is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.histogram.XBins + - plotly.graph_objs.histogram2d.XBins +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class YBins(dict): + """ + plotly.graph_objs.YBins is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.histogram.YBins + - plotly.graph_objs.histogram2d.YBins + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.YBins is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.histogram.YBins + - plotly.graph_objs.histogram2d.YBins + + """ + warnings.warn( + """plotly.graph_objs.YBins is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.histogram.YBins + - plotly.graph_objs.histogram2d.YBins +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Trace(dict): + """ + plotly.graph_objs.Trace is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.Scatter + - plotly.graph_objs.Bar + - plotly.graph_objs.Area + - plotly.graph_objs.Histogram + - etc. + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Trace is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.Scatter + - plotly.graph_objs.Bar + - plotly.graph_objs.Area + - plotly.graph_objs.Histogram + - etc. + + """ + warnings.warn( + """plotly.graph_objs.Trace is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.Scatter + - plotly.graph_objs.Bar + - plotly.graph_objs.Area + - plotly.graph_objs.Histogram + - etc. +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) + + +class Histogram2dcontour(dict): + """ + plotly.graph_objs.Histogram2dcontour is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.Histogram2dContour + + """ + + def __init__(self, *args, **kwargs): + """ + plotly.graph_objs.Histogram2dcontour is deprecated. + Please replace it with one of the following more specific types + - plotly.graph_objs.Histogram2dContour + + """ + warnings.warn( + """plotly.graph_objs.Histogram2dcontour is deprecated. +Please replace it with one of the following more specific types + - plotly.graph_objs.Histogram2dContour +""", + DeprecationWarning, + ) + super().__init__(*args, **kwargs) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_figure.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_figure.py new file mode 100644 index 0000000..a3c9f83 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_figure.py @@ -0,0 +1,24433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseFigure + + +class Figure(BaseFigure): + def __init__( + self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs + ): + """ + Create a new :class:Figure instance + + Parameters + ---------- + data + The 'data' property is a tuple of trace instances + that may be specified as: + - A list or tuple of trace instances + (e.g. [Scatter(...), Bar(...)]) + - A single trace instance + (e.g. Scatter(...), Bar(...), etc.) + - A list or tuple of dicts of string/value properties where: + - The 'type' property specifies the trace type + One of: ['bar', 'barpolar', 'box', 'candlestick', + 'carpet', 'choropleth', 'choroplethmap', + 'choroplethmapbox', 'cone', 'contour', + 'contourcarpet', 'densitymap', + 'densitymapbox', 'funnel', 'funnelarea', + 'heatmap', 'histogram', 'histogram2d', + 'histogram2dcontour', 'icicle', 'image', + 'indicator', 'isosurface', 'mesh3d', 'ohlc', + 'parcats', 'parcoords', 'pie', 'sankey', + 'scatter', 'scatter3d', 'scattercarpet', + 'scattergeo', 'scattergl', 'scattermap', + 'scattermapbox', 'scatterpolar', + 'scatterpolargl', 'scattersmith', + 'scatterternary', 'splom', 'streamtube', + 'sunburst', 'surface', 'table', 'treemap', + 'violin', 'volume', 'waterfall'] + + - All remaining properties are passed to the constructor of + the specified trace type + + (e.g. [{'type': 'scatter', ...}, {'type': 'bar, ...}]) + + layout + The 'layout' property is an instance of Layout + that may be specified as: + - An instance of :class:`plotly.graph_objs.Layout` + - A dict of string/value properties that will be passed + to the Layout constructor + + frames + The 'frames' property is a tuple of instances of + Frame that may be specified as: + - A list or tuple of instances of plotly.graph_objs.Frame + - A list or tuple of dicts of string/value properties that + will be passed to the Frame constructor + + skip_invalid: bool + 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 + + Raises + ------ + ValueError + if a property in the specification of data, layout, or frames + is invalid AND skip_invalid is False + """ + super().__init__(data, layout, frames, skip_invalid, **kwargs) + + def update(self, dict1=None, overwrite=False, **kwargs) -> "Figure": + """ + + Update the properties of the figure with a dict and/or with + keyword arguments. + + This recursively updates the structure of the figure + object with the values in the input dict / keyword arguments. + + Parameters + ---------- + dict1 : dict + Dictionary of properties to be updated + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + kwargs : + Keyword/value pair of properties to be updated + + Examples + -------- + >>> import plotly.graph_objs as go + >>> fig = go.Figure(data=[{'y': [1, 2, 3]}]) + >>> fig.update(data=[{'y': [4, 5, 6]}]) # doctest: +ELLIPSIS + Figure(...) + >>> fig.to_plotly_json() # doctest: +SKIP + {'data': [{'type': 'scatter', + 'uid': 'e86a7c7a-346a-11e8-8aa8-a0999b0c017b', + 'y': array([4, 5, 6], dtype=int32)}], + 'layout': {}} + + >>> fig = go.Figure(layout={'xaxis': + ... {'color': 'green', + ... 'range': [0, 1]}}) + >>> fig.update({'layout': {'xaxis': {'color': 'pink'}}}) # doctest: +ELLIPSIS + Figure(...) + >>> fig.to_plotly_json() # doctest: +SKIP + {'data': [], + 'layout': {'xaxis': + {'color': 'pink', + 'range': [0, 1]}}} + + Returns + ------- + BaseFigure + Updated figure + + """ + return super().update(dict1, overwrite, **kwargs) + + def update_traces( + self, + patch=None, + selector=None, + row=None, + col=None, + secondary_y=None, + overwrite=False, + **kwargs, + ) -> "Figure": + """ + + Perform a property update operation on all traces that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all traces that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all traces are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each trace and those for which the function returned True + will be in the selection. If an int N, the Nth trace matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of traces to select. + To select traces by row and column, the Figure must have been + created using plotly.subplots.make_subplots. If None + (the default), all traces are selected. + secondary_y: boolean or None (default None) + * If True, only select traces associated with the secondary + y-axis of the subplot. + * If False, only select traces associated with the primary + y-axis of the subplot. + * If None (the default), do not filter traces based on secondary + y-axis. + + To select traces by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + **kwargs + Additional property updates to apply to each selected trace. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the Figure object that the method was called on + + """ + return super().update_traces( + patch, selector, row, col, secondary_y, overwrite, **kwargs + ) + + def update_layout(self, dict1=None, overwrite=False, **kwargs) -> "Figure": + """ + + Update the properties of the figure's layout with a dict and/or with + keyword arguments. + + This recursively updates the structure of the original + layout with the values in the input dict / keyword arguments. + + Parameters + ---------- + dict1 : dict + Dictionary of properties to be updated + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + kwargs : + Keyword/value pair of properties to be updated + + Returns + ------- + BaseFigure + The Figure object that the update_layout method was called on + + """ + return super().update_layout(dict1, overwrite, **kwargs) + + def for_each_trace( + self, fn, selector=None, row=None, col=None, secondary_y=None + ) -> "Figure": + """ + + Apply a function to all traces that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single trace object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all traces are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each trace and those for which the function returned True + will be in the selection. If an int N, the Nth trace matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of traces to select. + To select traces by row and column, the Figure must have been + created using plotly.subplots.make_subplots. If None + (the default), all traces are selected. + secondary_y: boolean or None (default None) + * If True, only select traces associated with the secondary + y-axis of the subplot. + * If False, only select traces associated with the primary + y-axis of the subplot. + * If None (the default), do not filter traces based on secondary + y-axis. + + To select traces by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + + """ + return super().for_each_trace(fn, selector, row, col, secondary_y) + + def add_trace( + self, trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False + ) -> "Figure": + """ + + Add a trace to the figure + + Parameters + ---------- + trace : BaseTraceType or dict + Either: + - An instances of a trace classe from the plotly.graph_objs + package (e.g plotly.graph_objs.Scatter, plotly.graph_objs.Bar) + - or a dicts where: + + - The 'type' property specifies the trace type (e.g. + 'scatter', 'bar', 'area', etc.). If the dict has no 'type' + property then 'scatter' is assumed. + - All remaining properties are passed to the constructor + of the specified trace type. + + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`. + If 'all', addresses all rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`. + If 'all', addresses all columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + * The trace argument is a 2D cartesian trace + (scatter, bar, etc.) + exclude_empty_subplots: boolean + If True, the trace will not be added to subplots that don't already + have traces. + Returns + ------- + BaseFigure + The Figure that add_trace was called on + + Examples + -------- + + >>> from plotly import subplots + >>> import plotly.graph_objs as go + + Add two Scatter traces to a figure + + >>> fig = go.Figure() + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS + Figure(...) + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS + Figure(...) + + + Add two Scatter traces to vertically stacked subplots + + >>> fig = subplots.make_subplots(rows=2) + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) # doctest: +ELLIPSIS + Figure(...) + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) # doctest: +ELLIPSIS + Figure(...) + + """ + return super().add_trace(trace, row, col, secondary_y, exclude_empty_subplots) + + def add_traces( + self, + data, + rows=None, + cols=None, + secondary_ys=None, + exclude_empty_subplots=False, + ) -> "Figure": + """ + + Add traces to the figure + + Parameters + ---------- + data : list[BaseTraceType or dict] + A list of trace specifications to be added. + Trace specifications may be either: + + - Instances of trace classes from the plotly.graph_objs + package (e.g plotly.graph_objs.Scatter, plotly.graph_objs.Bar) + - Dicts where: + + - The 'type' property specifies the trace type (e.g. + 'scatter', 'bar', 'area', etc.). If the dict has no 'type' + property then 'scatter' is assumed. + - All remaining properties are passed to the constructor + of the specified trace type. + + rows : None, list[int], or int (default None) + List of subplot row indexes (starting from 1) for the traces to be + added. Only valid if figure was created using + `plotly.tools.make_subplots` + If a single integer is passed, all traces will be added to row number + + cols : None or list[int] (default None) + List of subplot column indexes (starting from 1) for the traces + to be added. Only valid if figure was created using + `plotly.tools.make_subplots` + If a single integer is passed, all traces will be added to column number + + + secondary_ys: None or list[boolean] (default None) + List of secondary_y booleans for traces to be added. See the + docstring for `add_trace` for more info. + + exclude_empty_subplots: boolean + If True, the trace will not be added to subplots that don't already + have traces. + + Returns + ------- + BaseFigure + The Figure that add_traces was called on + + Examples + -------- + + >>> from plotly import subplots + >>> import plotly.graph_objs as go + + Add two Scatter traces to a figure + + >>> fig = go.Figure() + >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]), + ... go.Scatter(x=[1,2,3], y=[2,1,2])]) # doctest: +ELLIPSIS + Figure(...) + + Add two Scatter traces to vertically stacked subplots + + >>> fig = subplots.make_subplots(rows=2) + >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]), + ... go.Scatter(x=[1,2,3], y=[2,1,2])], + ... rows=[1, 2], cols=[1, 1]) # doctest: +ELLIPSIS + Figure(...) + + """ + return super().add_traces( + data, rows, cols, secondary_ys, exclude_empty_subplots + ) + + def add_vline( + self, + x, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "Figure": + """ + + Add a vertical line to a plot or subplot that extends infinitely in the + y-dimension. + + Parameters + ---------- + x: float or int + A number representing the x coordinate of the vertical line. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the line. Example positions are "bottom left", "right top", + "right", "bottom". If an annotation is added but annotation_position is + not specified, this defaults to "top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_vline( + x, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def add_hline( + self, + y, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "Figure": + """ + + Add a horizontal line to a plot or subplot that extends infinitely in the + x-dimension. + + Parameters + ---------- + y: float or int + A number representing the y coordinate of the horizontal line. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the line. Example positions are "bottom left", "right top", + "right", "bottom". If an annotation is added but annotation_position is + not specified, this defaults to "top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_hline( + y, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def add_vrect( + self, + x0, + x1, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "Figure": + """ + + Add a rectangle to a plot or subplot that extends infinitely in the + y-dimension. + + Parameters + ---------- + x0: float or int + A number representing the x coordinate of one side of the rectangle. + x1: float or int + A number representing the x coordinate of the other side of the rectangle. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the rectangle. Example positions are "outside top left", "inside + bottom", "right", "inside left", "inside" ("outside" is not supported). If + an annotation is added but annotation_position is not specified this + defaults to "inside top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_vrect( + x0, x1, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def add_hrect( + self, + y0, + y1, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "Figure": + """ + + Add a rectangle to a plot or subplot that extends infinitely in the + x-dimension. + + Parameters + ---------- + y0: float or int + A number representing the y coordinate of one side of the rectangle. + y1: float or int + A number representing the y coordinate of the other side of the rectangle. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the rectangle. Example positions are "outside top left", "inside + bottom", "right", "inside left", "inside" ("outside" is not supported). If + an annotation is added but annotation_position is not specified this + defaults to "inside top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_hrect( + y0, y1, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def set_subplots(self, rows=None, cols=None, **make_subplots_args) -> "Figure": + """ + + Add subplots to this figure. If the figure already contains subplots, + then this throws an error. Accepts any keyword arguments that + plotly.subplots.make_subplots accepts. + + """ + return super().set_subplots(rows, cols, **make_subplots_args) + + def add_bar( + self, + alignmentgroup=None, + base=None, + basesrc=None, + cliponaxis=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Bar trace + + The data visualized by the span of the bars is set in `y` if + `orientation` is set to "v" (the default) and the labels are + set in `x`. By setting `orientation` to "h", the roles are + interchanged. + + Parameters + ---------- + 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. + base + Sets where the bar base is drawn (in position axis + units). In "stack" or "relative" barmode, traces that + set "base" will be excluded and drawn in "overlay" mode + instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties + error_y + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.bar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Bar + + new_trace = Bar( + alignmentgroup=alignmentgroup, + base=base, + basesrc=basesrc, + cliponaxis=cliponaxis, + constraintext=constraintext, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + error_x=error_x, + error_y=error_y, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetgroup=offsetgroup, + offsetsrc=offsetsrc, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + width=width, + widthsrc=widthsrc, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_barpolar( + self, + base=None, + basesrc=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetsrc=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Barpolar trace + + The data visualized by the radial span of the bars is set in + `r` + + Parameters + ---------- + base + Sets where the bar base is drawn (in radial axis + units). In "stack" barmode, traces that set "base" will + be excluded and drawn in "overlay" mode instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.barpolar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + 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. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties + 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). + width + Sets the bar angular width (in "thetaunit" units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Barpolar + + new_trace = Barpolar( + base=base, + basesrc=basesrc, + customdata=customdata, + customdatasrc=customdatasrc, + dr=dr, + dtheta=dtheta, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetsrc=offsetsrc, + opacity=opacity, + r=r, + r0=r0, + rsrc=rsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + theta=theta, + theta0=theta0, + thetasrc=thetasrc, + thetaunit=thetaunit, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + width=width, + widthsrc=widthsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_box( + self, + alignmentgroup=None, + boxmean=None, + boxpoints=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lowerfence=None, + lowerfencesrc=None, + marker=None, + mean=None, + meansrc=None, + median=None, + mediansrc=None, + meta=None, + metasrc=None, + name=None, + notched=None, + notchspan=None, + notchspansrc=None, + notchwidth=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + q1=None, + q1src=None, + q3=None, + q3src=None, + quartilemethod=None, + sd=None, + sdmultiple=None, + sdsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + showwhiskers=None, + sizemode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + upperfence=None, + upperfencesrc=None, + visible=None, + whiskerwidth=None, + width=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Box trace + + Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The + second quartile (Q2, i.e. the median) is marked by a line + inside the box. The fences grow outward from the boxes' edges, + by default they span +/- 1.5 times the interquartile range + (IQR: Q3-Q1), The sample mean and standard deviation as well as + notches and the sample, outlier and suspected outliers points + can be optionally added to the box plot. The values and + positions corresponding to each boxes can be input using two + signatures. The first signature expects users to supply the + sample values in the `y` data array for vertical boxes (`x` for + horizontal boxes). By supplying an `x` (`y`) array, one box per + distinct `x` (`y`) value is drawn If no `x` (`y`) list is + provided, a single box is drawn. In this case, the box is + positioned with the trace `name` or with `x0` (`y0`) if + provided. The second signature expects users to supply the + boxes corresponding Q1, median and Q3 statistics in the `q1`, + `median` and `q3` data arrays respectively. Other box features + relying on statistics namely `lowerfence`, `upperfence`, + `notchspan` can be set directly by the users. To have plotly + compute them or to show sample points besides the boxes, users + can set the `y` data array for vertical boxes (`x` for + horizontal boxes) to a 2D array with the outer length + corresponding to the number of boxes in the traces and the + inner length corresponding the sample size. + + Parameters + ---------- + 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. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside the + box(es). If "sd" the standard deviation is also drawn. + Defaults to True when `mean` is set. Defaults to "sd" + when `sd` is set Otherwise defaults to False. + boxpoints + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the box(es) are shown with no sample + points Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set. Defaults to "all" under the q1/median/q3 + signature. Otherwise defaults to "outliers". + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step for multi-box traces set + using q1/median/q3. + dy + Sets the y coordinate step for multi-box traces set + using q1/median/q3. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties + hoveron + Do the hover effects highlight individual boxes or + sample points or both? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the box(es). + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.box.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties + lowerfence + Sets the lower fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `lowerfence` is not provided but a sample (in `y` or + `x`) is set, we compute the lower as the last sample + point below 1.5 times the IQR. + lowerfencesrc + Sets the source reference on Chart Studio Cloud for + `lowerfence`. + marker + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties + mean + Sets the mean values. There should be as many items as + the number of boxes desired. This attribute has effect + only under the q1/median/q3 signature. If `mean` is not + provided but a sample (in `y` or `x`) is set, we + compute the mean for each box using the sample values. + meansrc + Sets the source reference on Chart Studio Cloud for + `mean`. + median + Sets the median values. There should be as many items + as the number of boxes desired. + mediansrc + Sets the source reference on Chart Studio Cloud for + `median`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + notched + Determines whether or not notches are drawn. Notches + displays a confidence interval around the median. We + compute the confidence interval as median +/- 1.57 * + IQR / sqrt(N), where IQR is the interquartile range and + N is the sample size. If two boxes' notches do not + overlap there is 95% confidence their medians differ. + See https://sites.google.com/site/davidsstatistics/home + /notched-box-plots for more info. Defaults to False + unless `notchwidth` or `notchspan` is set. + notchspan + Sets the notch span from the boxes' `median` values. + There should be as many items as the number of boxes + desired. This attribute has effect only under the + q1/median/q3 signature. If `notchspan` is not provided + but a sample (in `y` or `x`) is set, we compute it as + 1.57 * IQR / sqrt(N), where N is the sample size. + notchspansrc + Sets the source reference on Chart Studio Cloud for + `notchspan`. + notchwidth + Sets the width of the notches relative to the box' + width. For example, with 0, the notches are as wide as + the box(es). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the box(es). If 0, the sample points are places over + the center of the box(es). Positive (negative) values + correspond to positions to the right (left) for + vertical boxes and above (below) for horizontal boxes + q1 + Sets the Quartile 1 values. There should be as many + items as the number of boxes desired. + q1src + Sets the source reference on Chart Studio Cloud for + `q1`. + q3 + Sets the Quartile 3 values. There should be as many + items as the number of boxes desired. + q3src + Sets the source reference on Chart Studio Cloud for + `q3`. + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + sd + Sets the standard deviation values. There should be as + many items as the number of boxes desired. This + attribute has effect only under the q1/median/q3 + signature. If `sd` is not provided but a sample (in `y` + or `x`) is set, we compute the standard deviation for + each box using the sample values. + sdmultiple + Scales the box size when sizemode=sd Allowing boxes to + be drawn across any stddev range For example 1-stddev, + 3-stddev, 5-stddev + sdsrc + Sets the source reference on Chart Studio Cloud for + `sd`. + selected + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showwhiskers + Determines whether or not whiskers are visible. + Defaults to true for `sizemode` "quartiles", false for + "sd". + sizemode + Sets the upper and lower bound for the boxes quartiles + means box is drawn between Q1 and Q3 SD means the box + is drawn between Mean +- Standard Deviation Argument + sdmultiple (default 1) to scale the box size So it + could be drawn 1-stddev, 3-stddev etc + stream + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties + upperfence + Sets the upper fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `upperfence` is not provided but a sample (in `y` or + `x`) is set, we compute the upper as the last sample + point above 1.5 times the IQR. + upperfencesrc + Sets the source reference on Chart Studio Cloud for + `upperfence`. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + width + Sets the width of the box in data coordinate If 0 + (default value) the width is automatically selected + based on the positions of other box traces in the same + subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Box + + new_trace = Box( + alignmentgroup=alignmentgroup, + boxmean=boxmean, + boxpoints=boxpoints, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + jitter=jitter, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + lowerfence=lowerfence, + lowerfencesrc=lowerfencesrc, + marker=marker, + mean=mean, + meansrc=meansrc, + median=median, + mediansrc=mediansrc, + meta=meta, + metasrc=metasrc, + name=name, + notched=notched, + notchspan=notchspan, + notchspansrc=notchspansrc, + notchwidth=notchwidth, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + pointpos=pointpos, + q1=q1, + q1src=q1src, + q3=q3, + q3src=q3src, + quartilemethod=quartilemethod, + sd=sd, + sdmultiple=sdmultiple, + sdsrc=sdsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showwhiskers=showwhiskers, + sizemode=sizemode, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + upperfence=upperfence, + upperfencesrc=upperfencesrc, + visible=visible, + whiskerwidth=whiskerwidth, + width=width, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_candlestick( + self, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + low=None, + lowsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + whiskerwidth=None, + x=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + yaxis=None, + yhoverformat=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Candlestick trace + + The candlestick is a style of financial chart describing open, + high, low and close for a given `x` coordinate (most likely + time). The boxes represent the spread between the `open` and + `close` values and the lines represent the spread between the + `low` and `high` values Sample points where the close value is + higher (lower) then the open value are called increasing + (decreasing). By default, increasing candles are drawn in green + whereas decreasing are drawn in red. + + Parameters + ---------- + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.candlestick.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Candlestick + + new_trace = Candlestick( + close=close, + closesrc=closesrc, + customdata=customdata, + customdatasrc=customdatasrc, + decreasing=decreasing, + high=high, + highsrc=highsrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + increasing=increasing, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + low=low, + lowsrc=lowsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + open=open, + opensrc=opensrc, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + whiskerwidth=whiskerwidth, + x=x, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + yaxis=yaxis, + yhoverformat=yhoverformat, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_carpet( + self, + a=None, + a0=None, + aaxis=None, + asrc=None, + b=None, + b0=None, + baxis=None, + bsrc=None, + carpet=None, + cheaterslope=None, + color=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + font=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xsrc=None, + y=None, + yaxis=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Carpet trace + + The data describing carpet axis layout is set in `y` and + (optionally) also `x`. If only `y` is present, `x` the plot is + interpreted as a cheater plot and is filled in using the `y` + values. `x` and `y` may either be 2D arrays matching with each + dimension matching that of `a` and `b`, or they may be 1D + arrays with total length equal to that of `a` and `b`. + + Parameters + ---------- + a + An array containing values of the first parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the starting + coordinate and `da` the step. + aaxis + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + A two dimensional array of y coordinates at each carpet + point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the starting + coordinate and `db` the step. + baxis + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + cheaterslope + The shift applied to each successive row of data in + creating a cheater plot. Only used if `x` is been + omitted. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the a coordinate step. See `a0` for more info. + db + Sets the b coordinate step. See `b0` for more info. + font + The default font used for axis & tick labels on this + carpet + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.carpet.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + stream + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + A two dimensional array of x coordinates at each carpet + point. If omitted, the plot is a cheater plot and the + xaxis is hidden by default. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + A two dimensional array of y coordinates at each carpet + point. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Carpet + + new_trace = Carpet( + a=a, + a0=a0, + aaxis=aaxis, + asrc=asrc, + b=b, + b0=b0, + baxis=baxis, + bsrc=bsrc, + carpet=carpet, + cheaterslope=cheaterslope, + color=color, + customdata=customdata, + customdatasrc=customdatasrc, + da=da, + db=db, + font=font, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + stream=stream, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_choropleth( + self, + 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, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Choropleth trace + + The data that describes the choropleth value-to-color mapping + is set in `z`. The geographic locations corresponding to each + value in `z` are set in `locations`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choropleth.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Choropleth + + new_trace = Choropleth( + autocolorscale=autocolorscale, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + geo=geo, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + locationmode=locationmode, + locations=locations, + locationssrc=locationssrc, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + reversescale=reversescale, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_choroplethmap( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + subplot=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, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Choroplethmap trace + + GeoJSON features to be filled are set in `geojson` The data + that describes the choropleth value-to-color mapping is set in + `locations` and `z`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmap traces are placed above the water layers. + If set to '', the layer will be inserted above every + existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmap.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmap.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Choroplethmap + + new_trace = Choroplethmap( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + locations=locations, + locationssrc=locationssrc, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + reversescale=reversescale, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_choroplethmapbox( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + subplot=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, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Choroplethmapbox trace + + "choroplethmapbox" trace is deprecated! Please consider + switching to the "choroplethmap" trace type and `map` subplots. + Learn more at: https://plotly.com/python/maplibre-migration/ as + well as https://plotly.com/javascript/maplibre-migration/ + GeoJSON features to be filled are set in `geojson` The data + that describes the choropleth value-to-color mapping is set in + `locations` and `z`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmapbox traces are placed above the water + layers. If set to '', the layer will be inserted above + every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmapbox.Legendgro + uptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Choroplethmapbox + + new_trace = Choroplethmapbox( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + locations=locations, + locationssrc=locationssrc, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + reversescale=reversescale, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_cone( + self, + anchor=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + sizemode=None, + sizeref=None, + stream=None, + text=None, + textsrc=None, + u=None, + uhoverformat=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + vhoverformat=None, + visible=None, + vsrc=None, + w=None, + whoverformat=None, + wsrc=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Cone trace + + Use cone traces to visualize vector fields. Specify a vector + field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and + 3 vector component arrays `u`, `v`, `w`. The cones are drawn + exactly at the positions given by `x`, `y` and `z`. + + Parameters + ---------- + anchor + Sets the cones' anchor with respect to their x/y/z + positions. Note that "cm" denote the cone's center of + mass which corresponds to 1/4 from the tail to tip. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `norm` Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.cone.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.cone.Lighting` instance or + dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizemode + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in + the vector field) or as "absolute" value (in the same + units as the vector field). To display sizes in actual + vector length use "raw". + sizeref + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) + corresponds to the minimum "time" to travel across two + successive x/y/z positions at the average velocity of + those two successive positions. All cones in a given + trace use the same factor. With `sizemode` set to + "raw", its default value is 1. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is + 0.5. With `sizemode` set to "absolute", `sizeref` has + the same units as the u/v/w vector field, its the + default value is half the sample's maximum vector norm. + stream + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the cones. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field and of the + displayed cones. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field and of the + displayed cones. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field and of the + displayed cones. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Cone + + new_trace = Cone( + anchor=anchor, + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + sizemode=sizemode, + sizeref=sizeref, + stream=stream, + text=text, + textsrc=textsrc, + u=u, + uhoverformat=uhoverformat, + uid=uid, + uirevision=uirevision, + usrc=usrc, + v=v, + vhoverformat=vhoverformat, + visible=visible, + vsrc=vsrc, + w=w, + whoverformat=whoverformat, + wsrc=wsrc, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_contour( + self, + autocolorscale=None, + autocontour=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoverongaps=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textfont=None, + textsrc=None, + texttemplate=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Contour trace + + The data from which contour lines are computed is set in `z`. + Data in `z` must be a 2D list of numbers. Say that `z` has N + rows and M columns, then by default, these N rows correspond to + N y coordinates (set in `y` or auto-generated) and the M + columns correspond to M x coordinates (set in `x` or auto- + generated). By setting `transpose` to True, the above behavior + is flipped. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array otherwise it + is defaulted to false. + contours + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contour.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Contour + + new_trace = Contour( + autocolorscale=autocolorscale, + autocontour=autocontour, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + connectgaps=connectgaps, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoverongaps=hoverongaps, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + ncontours=ncontours, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textfont=textfont, + textsrc=textsrc, + texttemplate=texttemplate, + transpose=transpose, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + xtype=xtype, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + ytype=ytype, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zorder=zorder, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_contourcarpet( + self, + a=None, + a0=None, + asrc=None, + atype=None, + autocolorscale=None, + autocontour=None, + b=None, + b0=None, + bsrc=None, + btype=None, + carpet=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + fillcolor=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + xaxis=None, + yaxis=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Contourcarpet trace + + Plots contours on either the first carpet axis or the carpet + axis with a matching `carpet` attribute. Data `z` is + interpreted as matching that of the corresponding carpet axis. + + Parameters + ---------- + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + atype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + btype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + carpet + The `carpet` of the carpet axes on which this contour + trace lies + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the x coordinate step. See `x0` for more info. + db + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contourcarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Contourcarpet + + new_trace = Contourcarpet( + a=a, + a0=a0, + asrc=asrc, + atype=atype, + autocolorscale=autocolorscale, + autocontour=autocontour, + b=b, + b0=b0, + bsrc=bsrc, + btype=btype, + carpet=carpet, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + da=da, + db=db, + fillcolor=fillcolor, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + ncontours=ncontours, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textsrc=textsrc, + transpose=transpose, + uid=uid, + uirevision=uirevision, + visible=visible, + xaxis=xaxis, + yaxis=yaxis, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zorder=zorder, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_densitymap( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lon=None, + lonsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + radius=None, + radiussrc=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Densitymap trace + + Draws a bivariate kernel density estimation with a Gaussian + kernel from `lon` and `lat` coordinates and optional `z` values + using a colorscale. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymap trace will be inserted + before the layer with the specified ID. By default, + densitymap traces are placed below the first layer of + type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymap + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Densitymap + + new_trace = Densitymap( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lon=lon, + lonsrc=lonsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + radius=radius, + radiussrc=radiussrc, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_densitymapbox( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lon=None, + lonsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + radius=None, + radiussrc=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Densitymapbox trace + + "densitymapbox" trace is deprecated! Please consider switching + to the "densitymap" trace type and `map` subplots. Learn more + at: https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ Draws a + bivariate kernel density estimation with a Gaussian kernel from + `lon` and `lat` coordinates and optional `z` values using a + colorscale. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymapbox trace will be inserted + before the layer with the specified ID. By default, + densitymapbox traces are placed below the first layer + of type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymapbox + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Densitymapbox + + new_trace = Densitymapbox( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lon=lon, + lonsrc=lonsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + radius=radius, + radiussrc=radiussrc, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_funnel( + self, + alignmentgroup=None, + cliponaxis=None, + connector=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Funnel trace + + Visualize stages in a process using length-encoded bars. This + trace can be used to show data in either a part-to-whole + representation wherein each item appears in a single stage, or + in a "drop-off" representation wherein each item appears in + each stage it traversed. See also the "funnelarea" trace type + for a different approach to visualizing funnel data. + + Parameters + ---------- + 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. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious` and + `percentTotal`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnel.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the funnels. With "v" ("h"), + the value of the each bar spans along the vertical + (horizontal). By default funnels are tend to be + oriented horizontally; unless only "y" array is + presented or orientation is set to "v". Also regarding + graphs including only 'horizontal' funnels, "autorange" + on the "y-axis" are set to "reversed". + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple funnels, percentages & + totals are computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious`, + `percentTotal`, `label` and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Funnel + + new_trace = Funnel( + alignmentgroup=alignmentgroup, + cliponaxis=cliponaxis, + connector=connector, + constraintext=constraintext, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + visible=visible, + width=width, + x=x, + x0=x0, + xaxis=xaxis, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_funnelarea( + self, + aspectratio=None, + baseratio=None, + customdata=None, + customdatasrc=None, + dlabel=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + label0=None, + labels=None, + labelssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + scalegroup=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + title=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Funnelarea trace + + Visualize stages in a process using area-encoded trapezoids. + This trace can be used to show data in a part-to-whole + representation similar to a "pie" trace, wherein each item + appears in a single stage. See also the "funnel" trace type for + a different approach to visualizing funnel data. + + Parameters + ---------- + aspectratio + Sets the ratio between height and width + baseratio + Sets the ratio between bottom length and maximum top + length. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnelarea.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + scalegroup + If there are multiple funnelareas that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Funnelarea + + new_trace = Funnelarea( + aspectratio=aspectratio, + baseratio=baseratio, + customdata=customdata, + customdatasrc=customdatasrc, + dlabel=dlabel, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + label0=label0, + labels=labels, + labelssrc=labelssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + scalegroup=scalegroup, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + title=title, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_heatmap( + self, + autocolorscale=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoverongaps=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textfont=None, + textsrc=None, + texttemplate=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xgap=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ygap=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsmooth=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Heatmap trace + + The data that describes the heatmap value-to-color mapping is + set in `z`. Data in `z` can either be a 2D list of values + (ragged or not) or a 1D array of values. In the case where `z` + is a 2D list, say that `z` has N rows and M columns. Then, by + default, the resulting heatmap will have N partitions along the + y axis and M partitions along the x axis. In other words, the + i-th row/ j-th column cell in `z` is mapped to the i-th + partition of the y axis (starting from the bottom of the plot) + and the j-th partition of the x-axis (starting from the left of + the plot). This behavior can be flipped by using `transpose`. + Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) + elements. If M (N), then the coordinates correspond to the + center of the heatmap cells and the cells have equal width. If + M+1 (N+1), then the coordinates correspond to the edges of the + heatmap cells. In the case where `z` is a 1D list, the x and y + coordinates must be provided in `x` and `y` respectively to + form data triplets. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array and `zsmooth` + is not false; otherwise it is defaulted to false. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.heatmap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Heatmap + + new_trace = Heatmap( + autocolorscale=autocolorscale, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoverongaps=hoverongaps, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textfont=textfont, + textsrc=textsrc, + texttemplate=texttemplate, + transpose=transpose, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xgap=xgap, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + xtype=xtype, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + ygap=ygap, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + ytype=ytype, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zorder=zorder, + zsmooth=zsmooth, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_histogram( + self, + alignmentgroup=None, + autobinx=None, + autobiny=None, + bingroup=None, + cliponaxis=None, + constraintext=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, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + offsetgroup=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + xaxis=None, + xbins=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybins=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Histogram trace + + The sample data from which statistics are computed is set in + `x` for vertically spanning histograms and in `y` for + horizontally spanning histograms. Binning options are set + `xbins` and `ybins` respectively if no aggregation data is + provided. + + Parameters + ---------- + 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. + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + 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 `barmode` + "stack", "relative" and "group" are forced into the + same bingroup, Using `bingroup`, traces under `barmode` + "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 `bingroup` + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + cumulative + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `binNumber` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties + 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. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the text font. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label` and `value`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Histogram + + new_trace = Histogram( + alignmentgroup=alignmentgroup, + autobinx=autobinx, + autobiny=autobiny, + bingroup=bingroup, + cliponaxis=cliponaxis, + constraintext=constraintext, + cumulative=cumulative, + customdata=customdata, + customdatasrc=customdatasrc, + error_x=error_x, + error_y=error_y, + histfunc=histfunc, + histnorm=histnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + nbinsx=nbinsx, + nbinsy=nbinsy, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + x=x, + xaxis=xaxis, + xbins=xbins, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ybins=ybins, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_histogram2d( + self, + autobinx=None, + autobiny=None, + autocolorscale=None, + bingroup=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + textfont=None, + texttemplate=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbingroup=None, + xbins=None, + xcalendar=None, + xgap=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybingroup=None, + ybins=None, + ycalendar=None, + ygap=None, + yhoverformat=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsmooth=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Histogram2d trace + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a heatmap. + + Parameters + ---------- + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2d.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties + textfont + Sets the text font. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Histogram2d + + new_trace = Histogram2d( + autobinx=autobinx, + autobiny=autobiny, + autocolorscale=autocolorscale, + bingroup=bingroup, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + histfunc=histfunc, + histnorm=histnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + nbinsx=nbinsx, + nbinsy=nbinsy, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + textfont=textfont, + texttemplate=texttemplate, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xbingroup=xbingroup, + xbins=xbins, + xcalendar=xcalendar, + xgap=xgap, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ybingroup=ybingroup, + ybins=ybins, + ycalendar=ycalendar, + ygap=ygap, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsmooth=zsmooth, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_histogram2dcontour( + self, + autobinx=None, + autobiny=None, + autocolorscale=None, + autocontour=None, + bingroup=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + textfont=None, + texttemplate=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbingroup=None, + xbins=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybingroup=None, + ybins=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Histogram2dContour trace + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a contour plot. + + Parameters + ---------- + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2dcontour.Legendg + rouptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Histogram2dContour + + new_trace = Histogram2dContour( + autobinx=autobinx, + autobiny=autobiny, + autocolorscale=autocolorscale, + autocontour=autocontour, + bingroup=bingroup, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + histfunc=histfunc, + histnorm=histnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + nbinsx=nbinsx, + nbinsy=nbinsy, + ncontours=ncontours, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + textfont=textfont, + texttemplate=texttemplate, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xbingroup=xbingroup, + xbins=xbins, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ybingroup=ybingroup, + ybins=ybins, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_icicle( + self, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + labels=None, + labelssrc=None, + leaf=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + pathbar=None, + root=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + tiling=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Icicle trace + + Visualize hierarchal data from leaves (and/or outer branches) + towards root with rectangles. The icicle sectors are determined + by the entries in "labels" or "ids" and in "parents". + + Parameters + ---------- + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.icicle.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.icicle.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.icicle.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.icicle.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.icicle.Marker` instance or + dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.icicle.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.icicle.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.icicle.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.icicle.Tiling` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Icicle + + new_trace = Icicle( + branchvalues=branchvalues, + count=count, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + labels=labels, + labelssrc=labelssrc, + leaf=leaf, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + level=level, + marker=marker, + maxdepth=maxdepth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + parents=parents, + parentssrc=parentssrc, + pathbar=pathbar, + root=root, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + tiling=tiling, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_image( + self, + colormodel=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + source=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x0=None, + xaxis=None, + y0=None, + yaxis=None, + z=None, + zmax=None, + zmin=None, + zorder=None, + zsmooth=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Image trace + + Display an image, i.e. data on a 2D regular raster. By default, + when an image is displayed in a subplot, its y axis will be + reversed (ie. `autorange: 'reversed'`), constrained to the + domain (ie. `constrain: 'domain'`) and it will have the same + scale as its x axis (ie. `scaleanchor: 'x,`) in order for + pixels to be rendered as squares. + + Parameters + ---------- + colormodel + Color model used to map the numerical color components + described in `z` into colors. If `source` is specified, + this attribute will be set to `rgba256` otherwise it + defaults to `rgb`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Set the pixel's horizontal size. + dy + Set the pixel's vertical size + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `z`, `color` and `colormodel`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.image.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + source + Specifies the data URI of the image to be visualized. + The URI consists of "data:image/[][;base64]," + stream + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x0 + Set the image's x position. The left edge of the image + (or the right edge if the x axis is reversed or dx is + negative) will be found at xmin=x0-dx/2 + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + y0 + Set the image's y position. The top edge of the image + (or the bottom edge if the y axis is NOT reversed or if + dy is negative) will be found at ymin=y0-dy/2. By + default when an image trace is included, the y axis + will be reversed so that the image is right-side-up, + but you can disable this by setting + yaxis.autorange=true or by providing an explicit y axis + range. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + A 2-dimensional array in which each element is an array + of 3 or 4 numbers representing a color. + zmax + Array defining the higher bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [255, + 255, 255]. For the `rgba` colormodel, it is [255, 255, + 255, 1]. For the `rgba256` colormodel, it is [255, 255, + 255, 255]. For the `hsl` colormodel, it is [360, 100, + 100]. For the `hsla` colormodel, it is [360, 100, 100, + 1]. + zmin + Array defining the lower bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [0, 0, + 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For + the `rgba256` colormodel, it is [0, 0, 0, 0]. For the + `hsl` colormodel, it is [0, 0, 0]. For the `hsla` + colormodel, it is [0, 0, 0, 0]. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm used to smooth `z` data. + This only applies for image traces that use the + `source` attribute. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Image + + new_trace = Image( + colormodel=colormodel, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + source=source, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + x0=x0, + xaxis=xaxis, + y0=y0, + yaxis=yaxis, + z=z, + zmax=zmax, + zmin=zmin, + zorder=zorder, + zsmooth=zsmooth, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_indicator( + self, + align=None, + customdata=None, + customdatasrc=None, + delta=None, + domain=None, + gauge=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + mode=None, + name=None, + number=None, + stream=None, + title=None, + uid=None, + uirevision=None, + value=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Indicator trace + + An indicator is used to visualize a single `value` along with + some contextual information such as `steps` or a `threshold`, + using a combination of three visual elements: a number, a + delta, and/or a gauge. Deltas are taken with respect to a + `reference`. Gauges can be either angular or bullet (aka + linear) gauges. + + Parameters + ---------- + align + Sets the horizontal alignment of the `text` within the + box. Note that this attribute has no effect if an + angular gauge is displayed: in this case, it is always + centered + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delta + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties + domain + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties + gauge + The gauge of the Indicator plot. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.indicator.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines how the value is displayed on the graph. + `number` displays the value numerically in text. + `delta` displays the difference to a reference value in + text. Finally, `gauge` displays the value graphically + on an axis. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + number + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties + stream + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties + title + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the number to be displayed. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Indicator + + new_trace = Indicator( + align=align, + customdata=customdata, + customdatasrc=customdatasrc, + delta=delta, + domain=domain, + gauge=gauge, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + number=number, + stream=stream, + title=title, + uid=uid, + uirevision=uirevision, + value=value, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_isosurface( + self, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuehoverformat=None, + valuesrc=None, + visible=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Isosurface trace + + Draws isosurfaces between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.isosurface.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties + spaceframe + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties + surface + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Isosurface + + new_trace = Isosurface( + autocolorscale=autocolorscale, + caps=caps, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contour=contour, + customdata=customdata, + customdatasrc=customdatasrc, + flatshading=flatshading, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + isomax=isomax, + isomin=isomin, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + slices=slices, + spaceframe=spaceframe, + stream=stream, + surface=surface, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + value=value, + valuehoverformat=valuehoverformat, + valuesrc=valuesrc, + visible=visible, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_mesh3d( + self, + alphahull=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + delaunayaxis=None, + facecolor=None, + facecolorsrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + i=None, + ids=None, + idssrc=None, + intensity=None, + intensitymode=None, + intensitysrc=None, + isrc=None, + j=None, + jsrc=None, + k=None, + ksrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + vertexcolor=None, + vertexcolorsrc=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Mesh3d trace + + Draws sets of triangles with coordinates given by three + 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, + `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha- + shape algorithm or (4) the Convex-hull algorithm + + Parameters + ---------- + alphahull + Determines how the mesh surface triangles are derived + from the set of vertices (points) represented by the + `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays + are not supplied. For general use of `mesh3d` it is + preferred that `i`, `j`, `k` are supplied. If "-1", + Delaunay triangulation is used, which is mainly + suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In + case the `delaunayaxis` intersects the mesh surface at + more than one point it will result triangles that are + very long in the dimension of `delaunayaxis`. If ">0", + the alpha-shape algorithm is used. In this case, the + positive `alphahull` value signals the use of the + alpha-shape algorithm, _and_ its value acts as the + parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or + if the intention is to enclose the `x`, `y` and `z` + point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `intensity`) or + the bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `intensity` and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `intensity`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `intensity` and if set, `cmax` + must be set as well. + color + Sets the color of the whole mesh + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delaunayaxis + Sets the Delaunay axis, which is the axis that is + perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, `k` are + not provided and `alphahull` is set to indicate + Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" and + "vertexcolor". + facecolorsrc + Sets the source reference on Chart Studio Cloud for + `facecolor`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + i + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "first" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `i[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in space, which + is the first vertex of a triangle. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + intensity + Sets the intensity values for vertices or cells as + defined by `intensitymode`. It can be used for plotting + fields on meshes. + intensitymode + Determines the source of `intensity` values. + intensitysrc + Sets the source reference on Chart Studio Cloud for + `intensity`. + isrc + Sets the source reference on Chart Studio Cloud for + `i`. + j + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "second" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `j[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in space, which + is the second vertex of a triangle. + jsrc + Sets the source reference on Chart Studio Cloud for + `j`. + k + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "third" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `k[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in space, which + is the third vertex of a triangle. + ksrc + Sets the source reference on Chart Studio Cloud for + `k`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.mesh3d.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides "color". While + Red, green and blue colors are in the range of 0 and + 255; in the case of having vertex color data in RGBA + format, the alpha color should be normalized to be + between 0 and 1. + vertexcolorsrc + Sets the source reference on Chart Studio Cloud for + `vertexcolor`. + 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). + x + Sets the X coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Mesh3d + + new_trace = Mesh3d( + alphahull=alphahull, + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + color=color, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contour=contour, + customdata=customdata, + customdatasrc=customdatasrc, + delaunayaxis=delaunayaxis, + facecolor=facecolor, + facecolorsrc=facecolorsrc, + flatshading=flatshading, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + i=i, + ids=ids, + idssrc=idssrc, + intensity=intensity, + intensitymode=intensitymode, + intensitysrc=intensitysrc, + isrc=isrc, + j=j, + jsrc=jsrc, + k=k, + ksrc=ksrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + vertexcolor=vertexcolor, + vertexcolorsrc=vertexcolorsrc, + visible=visible, + x=x, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zcalendar=zcalendar, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_ohlc( + self, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + low=None, + lowsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + tickwidth=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + yaxis=None, + yhoverformat=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Ohlc trace + + The ohlc (short for Open-High-Low-Close) is a style of + financial chart describing open, high, low and close for a + given `x` coordinate (most likely time). The tip of the lines + represent the `low` and `high` values and the horizontal + segments represent the `open` and `close` values. Sample points + where the close value is higher (lower) then the open value are + called increasing (decreasing). By default, increasing items + are drawn in green whereas decreasing are drawn in red. + + Parameters + ---------- + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.ohlc.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + tickwidth + Sets the width of the open/close tick marks relative to + the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Ohlc + + new_trace = Ohlc( + close=close, + closesrc=closesrc, + customdata=customdata, + customdatasrc=customdatasrc, + decreasing=decreasing, + high=high, + highsrc=highsrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + increasing=increasing, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + low=low, + lowsrc=lowsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + open=open, + opensrc=opensrc, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textsrc=textsrc, + tickwidth=tickwidth, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + yaxis=yaxis, + yhoverformat=yhoverformat, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_parcats( + self, + arrangement=None, + bundlecolors=None, + counts=None, + countssrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + hoverinfo=None, + hoveron=None, + hovertemplate=None, + labelfont=None, + legendgrouptitle=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + sortpaths=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Parcats trace + + Parallel categories diagram for multidimensional categorical + data. + + Parameters + ---------- + arrangement + Sets the drag interaction mode for categories and + dimensions. If `perpendicular`, the categories can only + move along a line perpendicular to the paths. If + `freeform`, the categories can freely move on the + plane. If `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled together + within each category. + counts + The number of observations represented by each state. + Defaults to 1 so that each state represents one + observation + countssrc + Sets the source reference on Chart Studio Cloud for + `counts`. + dimensions + The dimensions (variables) of the parallel categories + diagram. + dimensiondefaults + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets + the default property values to use for elements of + parcats.dimensions + domain + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take place + per category. If `color`, hover interactions take place + per color per category. If `dimension`, hover + interactions take place across all categories per + dimension. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. This value here applies when hovering + over dimensions. Note that `*categorycount`, + "colorcount" and "bandcolorcount" are only available + when `hoveron` contains the "color" flagFinally, the + template string has access to variables `count`, + `probability`, `category`, `categorycount`, + `colorcount` and `bandcolorcount`. Anything contained + in tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + labelfont + Sets the font for the `dimension` labels. + legendgrouptitle + :class:`plotly.graph_objects.parcats.Legendgrouptitle` + instance or dict with compatible properties + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, sort + paths based on dimension categories from left to right. + If `backward`, sort paths based on dimensions + categories from right to left. + stream + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Parcats + + new_trace = Parcats( + arrangement=arrangement, + bundlecolors=bundlecolors, + counts=counts, + countssrc=countssrc, + dimensions=dimensions, + dimensiondefaults=dimensiondefaults, + domain=domain, + hoverinfo=hoverinfo, + hoveron=hoveron, + hovertemplate=hovertemplate, + labelfont=labelfont, + legendgrouptitle=legendgrouptitle, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + sortpaths=sortpaths, + stream=stream, + tickfont=tickfont, + uid=uid, + uirevision=uirevision, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_parcoords( + self, + customdata=None, + customdatasrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + ids=None, + idssrc=None, + labelangle=None, + labelfont=None, + labelside=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + rangefont=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Parcoords trace + + Parallel coordinates for multidimensional exploratory data + analysis. The samples are specified in `dimensions`. The colors + are set in `line.color`. + + Parameters + ---------- + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dimensions + The dimensions (variables) of the parallel coordinates + chart. 2..60 dimensions are supported. + dimensiondefaults + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets + the default property values to use for elements of + parcoords.dimensions + domain + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + labelangle + Sets the angle of the labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + labels vertically. Tilted labels with "labelangle" may + be positioned better inside margins when + `labelposition` is set to "bottom". + labelfont + Sets the font for the `dimension` labels. + labelside + Specifies the location of the `label`. "top" positions + labels above, next to the title "bottom" positions + labels below the graph Tilted labels with "labelangle" + may be positioned better inside margins when + `labelposition` is set to "bottom". + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.parcoords.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + rangefont + Sets the font for the `dimension` range values. + stream + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.parcoords.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Parcoords + + new_trace = Parcoords( + customdata=customdata, + customdatasrc=customdatasrc, + dimensions=dimensions, + dimensiondefaults=dimensiondefaults, + domain=domain, + ids=ids, + idssrc=idssrc, + labelangle=labelangle, + labelfont=labelfont, + labelside=labelside, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + rangefont=rangefont, + stream=stream, + tickfont=tickfont, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_pie( + self, + automargin=None, + customdata=None, + customdatasrc=None, + direction=None, + dlabel=None, + domain=None, + hole=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + insidetextorientation=None, + label0=None, + labels=None, + labelssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + pull=None, + pullsrc=None, + rotation=None, + scalegroup=None, + showlegend=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + title=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Pie trace + + A data visualized by the sectors of the pie is set in `values`. + The sector labels are set in `labels`. The sector colors are + set in `marker.colors` + + Parameters + ---------- + automargin + Determines whether outside text labels can push the + margins. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + direction + Specifies the direction at which succeeding sectors + follow one another. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties + hole + Sets the fraction of the radius to cut out of the pie. + Use this to make a donut chart. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.pie.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. + pull + Sets the fraction of larger radius to pull the sectors + out from the center. This can be a constant to pull all + slices apart from each other equally or an array to + highlight one or more slices. + pullsrc + Sets the source reference on Chart Studio Cloud for + `pull`. + rotation + Instead of the first slice starting at 12 o'clock, + rotate to some other angle. + scalegroup + If there are multiple pie charts that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Pie + + new_trace = Pie( + automargin=automargin, + customdata=customdata, + customdatasrc=customdatasrc, + direction=direction, + dlabel=dlabel, + domain=domain, + hole=hole, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + insidetextorientation=insidetextorientation, + label0=label0, + labels=labels, + labelssrc=labelssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + pull=pull, + pullsrc=pullsrc, + rotation=rotation, + scalegroup=scalegroup, + showlegend=showlegend, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + title=title, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_sankey( + self, + arrangement=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverlabel=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Sankey trace + + Sankey plots for network flow data analysis. The nodes are + specified in `nodes` and the links between sources and targets + in `links`. The colors are set in `nodes[i].color` and + `links[i].color`, otherwise defaults are used. + + Parameters + ---------- + arrangement + If value is `snap` (the default), the node arrangement + is assisted by automatic snapping of elements to + preserve space between nodes specified via `nodepad`. + If value is `perpendicular`, the nodes can only move + along a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the plane. If + value is `fixed`, the nodes are stationary. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. Note that this attribute is + superseded by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sankey.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + link + The links of the Sankey plot. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + node + The nodes of the Sankey plot. + orientation + Sets the orientation of the Sankey diagram. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + stream + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + valuesuffix + Adds a unit to follow the value in the hover tooltip. + Add a space if a separation is necessary from the + value. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Sankey + + new_trace = Sankey( + arrangement=arrangement, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverlabel=hoverlabel, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + link=link, + meta=meta, + metasrc=metasrc, + name=name, + node=node, + orientation=orientation, + selectedpoints=selectedpoints, + stream=stream, + textfont=textfont, + uid=uid, + uirevision=uirevision, + valueformat=valueformat, + valuesuffix=valuesuffix, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatter( + self, + alignmentgroup=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + fillgradient=None, + fillpattern=None, + groupnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + selected=None, + selectedpoints=None, + showlegend=None, + stackgaps=None, + stackgroup=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scatter trace + + The scatter trace type encompasses line charts, scatter charts, + text charts, and bubble charts. The data visualized as scatter + point or lines is set in `x` and `y`. Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + 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. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. If fillgradient is + specified, fillcolor is ignored except for setting the + background color of the hover label, if any. + fillgradient + Sets a fill gradient. If not specified, the fillcolor + is used instead. + fillpattern + Sets the pattern within the marker. + groupnorm + Only relevant when `stackgroup` is used, and only the + first `groupnorm` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value of each + trace at each location is divided by the sum of all + trace values at that location. "percent" is the same + but multiplied by 100 to show percentages. If there are + multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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. + opacity + Sets the opacity of the trace. + orientation + Only relevant in the following cases: 1. when + `scattermode` is set to "group". 2. when `stackgroup` + is used, and only the first `orientation` found in the + `stackgroup` will be used - including if `visible` is + "legendonly" but not if it is `false`. Sets the + stacking direction. With "v" ("h"), the y (x) values of + subsequent traces are added. Also affects the default + value of `fill`. + selected + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and only the + first `stackgaps` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Determines how we handle locations at + which other traces in this group have data but this one + does not. With *infer zero* we insert a zero at these + locations. With "interpolate" we linearly interpolate + between existing values, and extrapolate a constant + beyond the existing values. + stackgroup + Set several scatter traces (on the same subplot) to the + same stackgroup in order to add their y values (or + their x values if `orientation` is "h"). If blank or + omitted this trace will not be stacked. Stacking also + turns `fill` on by default, using "tonexty" ("tonextx") + if `orientation` is "h" ("v") and sets the default + `mode` to "lines" irrespective of point count. You can + only stack on a numeric (linear or log) axis. Traces in + a `stackgroup` will only fill to (or be filled to) + other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if + fill-linked traces are not already consecutive, the + later ones will be pushed down in the drawing order. + stream + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scatter + + new_trace = Scatter( + alignmentgroup=alignmentgroup, + cliponaxis=cliponaxis, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + error_x=error_x, + error_y=error_y, + fill=fill, + fillcolor=fillcolor, + fillgradient=fillgradient, + fillpattern=fillpattern, + groupnorm=groupnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stackgaps=stackgaps, + stackgroup=stackgroup, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_scatter3d( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + error_x=None, + error_y=None, + error_z=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + projection=None, + scene=None, + showlegend=None, + stream=None, + surfaceaxis=None, + surfacecolor=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scatter3d trace + + The data visualized as scatter point or lines in 3D dimension + is set in `x`, `y`, `z`. Text (appearing either on the chart or + on hover only) is via `text`. Bubble charts are achieved by + setting `marker.size` and/or `marker.color` Projections are + achieved via `projection`. Surface fills are achieved via + `surfaceaxis`. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties + error_z + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter3d.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + projection + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a surface + If 0, 1, 2, the scatter points are filled with a + Delaunay surface about the x, y, z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scatter3d + + new_trace = Scatter3d( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + error_x=error_x, + error_y=error_y, + error_z=error_z, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + projection=projection, + scene=scene, + showlegend=showlegend, + stream=stream, + surfaceaxis=surfaceaxis, + surfacecolor=surfacecolor, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zcalendar=zcalendar, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattercarpet( + self, + a=None, + asrc=None, + b=None, + bsrc=None, + carpet=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxis=None, + yaxis=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scattercarpet trace + + Plots a scatter trace on either the first carpet axis or the + carpet axis with a matching `carpet` attribute. + + Parameters + ---------- + a + Sets the a-axis coordinates. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b). To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattercarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (a,b) point. If + a single string, the same string appears over all the + data points. If an array of strings, the items are + mapped in order to the the data points in (a,b). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scattercarpet + + new_trace = Scattercarpet( + a=a, + asrc=asrc, + b=b, + bsrc=bsrc, + carpet=carpet, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + xaxis=xaxis, + yaxis=yaxis, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_scattergeo( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + fill=None, + fillcolor=None, + geo=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + locationmode=None, + locations=None, + locationssrc=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scattergeo trace + + The data visualized as scatter point or lines on a geographic + map is provided either by longitude/latitude pairs in `lon` and + `lat` respectively or by geographic location IDs or names in + `locations`. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + geojson + Sets optional GeoJSON data associated with this trace. + If not given, the features on the base map are used + when `locations` is set. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair or item in `locations`. If a single string, the + same string appears over all the data points. If an + array of string, the items are mapped in order to the + this trace's (lon,lat) or `locations` coordinates. To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergeo.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each location + given. See `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (lon,lat) pair + or item in `locations`. If a single string, the same + string appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and "hovertext" is + not set, these elements will be seen in the hover + labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon`, `location` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scattergeo + + new_trace = Scattergeo( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + fill=fill, + fillcolor=fillcolor, + geo=geo, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + locationmode=locationmode, + locations=locations, + locationssrc=locationssrc, + lon=lon, + lonsrc=lonsrc, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattergl( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scattergl trace + + The data visualized as scatter point or lines is set in `x` and + `y` using the WebGL plotting engine. Bubble charts are achieved + by setting `marker.size` and/or `marker.color` to a numerical + arrays. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergl.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scattergl + + new_trace = Scattergl( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + error_x=error_x, + error_y=error_y, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_scattermap( + self, + below=None, + cluster=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scattermap trace + + The data visualized as scatter point, lines or marker symbols + on a MapLibre GL geographic map is provided by + longitude/latitude pairs in `lon` and `lat`. + + Parameters + ---------- + below + Determines if this scattermap trace's layers are to be + inserted before the layer with the specified ID. By + default, scattermap layers are inserted above all the + base layers. To place the scattermap layers above every + other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermap.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermap.Line` instance + or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=map.layer.paint.text- + color, size=map.layer.layout.text-size). Has an effect + only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermap.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scattermap + + new_trace = Scattermap( + below=below, + cluster=cluster, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + lon=lon, + lonsrc=lonsrc, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattermapbox( + self, + below=None, + cluster=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scattermapbox trace + + "scattermapbox" trace is deprecated! Please consider switching + to the "scattermap" trace type and `map` subplots. Learn more + at: https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ The data + visualized as scatter point, lines or marker symbols on a + Mapbox GL geographic map is provided by longitude/latitude + pairs in `lon` and `lat`. + + Parameters + ---------- + below + Determines if this scattermapbox trace's layers are to + be inserted before the layer with the specified ID. By + default, scattermapbox layers are inserted above all + the base layers. To place the scattermapbox layers + above every other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermapbox.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scattermapbox + + new_trace = Scattermapbox( + below=below, + cluster=cluster, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + lon=lon, + lonsrc=lonsrc, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatterpolar( + self, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scatterpolar trace + + The scatterpolar trace type encompasses line charts, scatter + charts, text charts, and bubble charts in polar coordinates. + The data visualized as scatter point or lines is set in `r` + (radial) and `theta` (angular) coordinates Text (appearing + either on the chart or on hover only) is via `text`. Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterpolar has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolar.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scatterpolar + + new_trace = Scatterpolar( + cliponaxis=cliponaxis, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dr=dr, + dtheta=dtheta, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + r=r, + r0=r0, + rsrc=rsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + theta=theta, + theta0=theta0, + thetasrc=thetasrc, + thetaunit=thetaunit, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatterpolargl( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scatterpolargl trace + + The scatterpolargl trace type encompasses line charts, scatter + charts, and bubble charts in polar coordinates using the WebGL + plotting engine. The data visualized as scatter point or lines + is set in `r` (radial) and `theta` (angular) coordinates Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolargl.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scatterpolargl + + new_trace = Scatterpolargl( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dr=dr, + dtheta=dtheta, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + r=r, + r0=r0, + rsrc=rsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + theta=theta, + theta0=theta0, + thetasrc=thetasrc, + thetaunit=thetaunit, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattersmith( + self, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + imag=None, + imagsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + real=None, + realsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scattersmith trace + + The scattersmith trace type encompasses line charts, scatter + charts, text charts, and bubble charts in smith coordinates. + The data visualized as scatter point or lines is set in `real` + and `imag` (imaginary) coordinates Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scattersmith has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattersmith.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + imag + Sets the imaginary component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + imagsrc + Sets the source reference on Chart Studio Cloud for + `imag`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattersmith.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattersmith.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattersmith.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + real + Sets the real component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + realsrc + Sets the source reference on Chart Studio Cloud for + `real`. + selected + :class:`plotly.graph_objects.scattersmith.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattersmith.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a smith subplot. If "smith" (the default value), + the data refer to `layout.smith`. If "smith2", the data + refer to `layout.smith2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `real`, `imag` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattersmith.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scattersmith + + new_trace = Scattersmith( + cliponaxis=cliponaxis, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + imag=imag, + imagsrc=imagsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + real=real, + realsrc=realsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatterternary( + self, + a=None, + asrc=None, + b=None, + bsrc=None, + c=None, + cliponaxis=None, + connectgaps=None, + csrc=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + sum=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Scatterternary trace + + Provides similar functionality to the "scatter" type but on a + ternary phase diagram. The data is provided by at least two + arrays out of `a`, `b`, `c` triplets. + + Parameters + ---------- + a + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + c + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + csrc + Sets the source reference on Chart Studio Cloud for + `c`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b,c) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b,c). + To be seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterternary.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a ternary subplot. If "ternary" (the default + value), the data refer to `layout.ternary`. If + "ternary2", the data refer to `layout.ternary2`, and so + on. + sum + The number each triplet should sum to, if only two of + `a`, `b`, and `c` are provided. This overrides + `ternary.sum` to normalize this specific trace, but + does not affect the values displayed on the axes. 0 (or + missing) means to use ternary.sum + text + Sets text elements associated with each (a,b,c) point. + If a single string, the same string appears over all + the data points. If an array of strings, the items are + mapped in order to the the data points in (a,b,c). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b`, `c` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Scatterternary + + new_trace = Scatterternary( + a=a, + asrc=asrc, + b=b, + bsrc=bsrc, + c=c, + cliponaxis=cliponaxis, + connectgaps=connectgaps, + csrc=csrc, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + sum=sum, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_splom( + self, + customdata=None, + customdatasrc=None, + diagonal=None, + dimensions=None, + dimensiondefaults=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + showlowerhalf=None, + showupperhalf=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxes=None, + xhoverformat=None, + yaxes=None, + yhoverformat=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Splom trace + + Splom traces generate scatter plot matrix visualizations. Each + splom `dimensions` items correspond to a generated axis. Values + for each of those dimensions are set in `dimensions[i].values`. + Splom traces support all `scattergl` marker style attributes. + Specify `layout.grid` attributes and/or layout x-axis and + y-axis attributes for more control over the axis positioning + and style. + + Parameters + ---------- + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + diagonal + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties + dimensions + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the + default property values to use for elements of + splom.dimensions + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.splom.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower half + from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper half + from the diagonal are displayed. + stream + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair to + appear on hover. If a single string, the same string + appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties + 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). + xaxes + Sets the list of x axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N xaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + yaxes + Sets the list of y axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N yaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Splom + + new_trace = Splom( + customdata=customdata, + customdatasrc=customdatasrc, + diagonal=diagonal, + dimensions=dimensions, + dimensiondefaults=dimensiondefaults, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showlowerhalf=showlowerhalf, + showupperhalf=showupperhalf, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + xaxes=xaxes, + xhoverformat=xhoverformat, + yaxes=yaxes, + yhoverformat=yhoverformat, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_streamtube( + self, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + maxdisplayed=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + sizeref=None, + starts=None, + stream=None, + text=None, + u=None, + uhoverformat=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + vhoverformat=None, + visible=None, + vsrc=None, + w=None, + whoverformat=None, + wsrc=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Streamtube trace + + Use a streamtube trace to visualize flow in a vector field. + Specify a vector field using 6 1D arrays of equal length, 3 + position arrays `x`, `y` and `z` and 3 vector component arrays + `u`, `v`, and `w`. By default, the tubes' starting positions + will be cut from the vector field's x-z plane at its minimum y + value. To specify your own starting position, use attributes + `starts.x`, `starts.y` and `starts.z`. The color is encoded by + the norm of (u, v, w), and the local radius by the divergence + of (u, v, w). + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `tubex`, `tubey`, `tubez`, `tubeu`, + `tubev`, `tubew`, `norm` and `divergence`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.streamtube.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizeref + The scaling factor for the streamtubes. The default is + 1, which avoids two max divergence tubes from touching + at adjacent starting positions. + starts + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties + text + Sets a text element associated with this trace. If + trace `hoverinfo` contains a "text" flag, this text + element will be seen in all hover labels. Note that + streamtube traces do not support array `text` values. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Streamtube + + new_trace = Streamtube( + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + maxdisplayed=maxdisplayed, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + sizeref=sizeref, + starts=starts, + stream=stream, + text=text, + u=u, + uhoverformat=uhoverformat, + uid=uid, + uirevision=uirevision, + usrc=usrc, + v=v, + vhoverformat=vhoverformat, + visible=visible, + vsrc=vsrc, + w=w, + whoverformat=whoverformat, + wsrc=wsrc, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_sunburst( + self, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + insidetextorientation=None, + labels=None, + labelssrc=None, + leaf=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + root=None, + rotation=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Sunburst trace + + Visualize hierarchal data spanning outward radially from root + to leaves. The sunburst sectors are determined by the entries + in "labels" or "ids" and in "parents". + + Parameters + ---------- + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sunburst.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented at the center of a sunburst graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + root + :class:`plotly.graph_objects.sunburst.Root` instance or + dict with compatible properties + rotation + Rotates the whole diagram counterclockwise by some + angle. By default the first slice starts at 3 o'clock. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Sunburst + + new_trace = Sunburst( + branchvalues=branchvalues, + count=count, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + insidetextorientation=insidetextorientation, + labels=labels, + labelssrc=labelssrc, + leaf=leaf, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + level=level, + marker=marker, + maxdepth=maxdepth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + parents=parents, + parentssrc=parentssrc, + root=root, + rotation=rotation, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_surface( + self, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + hidesurface=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + opacityscale=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + stream=None, + surfacecolor=None, + surfacecolorsrc=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Surface trace + + The data the describes the coordinates of the surface is set in + `z`. Data in `z` should be a 2D list. Coordinates in `x` and + `y` can either be 1D lists or 2D lists (e.g. to graph + parametric surfaces). If not provided in `x` and `y`, the x and + y coordinates are assumed to be linear starting at 0 with a + unit step. The color scale corresponds to the `z` values by + default. For custom color scales, use `surfacecolor` which + should be a 2D list, where its bounds can be controlled using + `cmin` and `cmax`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here z or surfacecolor) + or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as z or surfacecolor. + Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + contours + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hidesurface + Determines whether or not a surface is drawn. For + example, set `hidesurface` to False `contours.x.show` + to True and `contours.y.show` to True to draw a wire + frame plot. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.surface.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties + surfacecolor + Sets the surface color values, used for setting a color + scale independent of `z`. + surfacecolorsrc + Sets the source reference on Chart Studio Cloud for + `surfacecolor`. + text + Sets the text elements associated with each z value. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Surface + + new_trace = Surface( + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + connectgaps=connectgaps, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + hidesurface=hidesurface, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + opacityscale=opacityscale, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + stream=stream, + surfacecolor=surfacecolor, + surfacecolorsrc=surfacecolorsrc, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zcalendar=zcalendar, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_table( + self, + cells=None, + columnorder=None, + columnordersrc=None, + columnwidth=None, + columnwidthsrc=None, + customdata=None, + customdatasrc=None, + domain=None, + header=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Table trace + + Table view for detailed data viewing. The data are arranged in + a grid of rows and columns. Most styling can be specified for + columns, rows or individual cells. Table is using a column- + major order, ie. the grid is represented as a vector of column + vectors. + + Parameters + ---------- + cells + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties + columnorder + Specifies the rendered order of the data columns; for + example, a value `2` at position `0` means that column + index `0` in the data will be rendered as the third + column, as columns have an index base of zero. + columnordersrc + Sets the source reference on Chart Studio Cloud for + `columnorder`. + columnwidth + The width of columns expressed as a ratio. Columns fill + the available width in proportion of their specified + column widths. + columnwidthsrc + Sets the source reference on Chart Studio Cloud for + `columnwidth`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties + header + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.table.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + stream + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Table + + new_trace = Table( + cells=cells, + columnorder=columnorder, + columnordersrc=columnordersrc, + columnwidth=columnwidth, + columnwidthsrc=columnwidthsrc, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + header=header, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + stream=stream, + uid=uid, + uirevision=uirevision, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_treemap( + self, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + labels=None, + labelssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + pathbar=None, + root=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + tiling=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Treemap trace + + Visualize hierarchal data from leaves (and/or outer branches) + towards root with rectangles. The treemap sectors are + determined by the entries in "labels" or "ids" and in + "parents". + + Parameters + ---------- + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.treemap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.treemap.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Treemap + + new_trace = Treemap( + branchvalues=branchvalues, + count=count, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + labels=labels, + labelssrc=labelssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + level=level, + marker=marker, + maxdepth=maxdepth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + parents=parents, + parentssrc=parentssrc, + pathbar=pathbar, + root=root, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + tiling=tiling, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_violin( + self, + alignmentgroup=None, + bandwidth=None, + box=None, + customdata=None, + customdatasrc=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meanline=None, + meta=None, + metasrc=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + points=None, + quartilemethod=None, + scalegroup=None, + scalemode=None, + selected=None, + selectedpoints=None, + showlegend=None, + side=None, + span=None, + spanmode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Violin trace + + In vertical (horizontal) violin plots, statistics are computed + using `y` (`x`) values. By supplying an `x` (`y`) array, one + violin per distinct x (y) value is drawn If no `x` (`y`) list + is provided, a single violin is drawn. That violin position is + then positioned with with `name` or with `x0` (`y0`) if + provided. + + Parameters + ---------- + 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. + bandwidth + Sets the bandwidth used to compute the kernel density + estimate. By default, the bandwidth is determined by + Silverman's rule of thumb. + box + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual violins or + sample points or the kernel density estimate or any + combination of them? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the violins. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.violin.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties + meanline + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For violin traces, the name + will also be used for the position coordinate, if `x` + and `x0` (`y` and `y0` if horizontal) are missing and + the position axis is categorical. Note that the trace + name is also used as a default value for attribute + `scalegroup` (please see its description for details). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" ("h"), + the distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the violins. If 0, the sample points are places over + the center of the violins. Positive (negative) values + correspond to positions to the right (left) for + vertical violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the violins are shown with no sample + points. Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set, otherwise defaults to "outliers". + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + scalegroup + If there are multiple violins that should be sized + according to to some metric (see `scalemode`), link + them by providing a non-empty group id here shared by + every trace in the same group. If a violin's `width` is + undefined, `scalegroup` will default to the trace's + name. In this case, violins with the same names will be + linked together + scalemode + Sets the metric by which the width of each violin is + determined. "width" means each violin has the same + (max) width "count" means the violins are scaled by the + number of sample points making up each violin. + selected + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + side + Determines on which side of the position value the + density function making up one half of a violin is + plotted. Useful when comparing two violin traces under + "overlay" mode, where one trace has `side` set to + "positive" and the other to "negative". + span + Sets the span in data space for which the density + function will be computed. Has an effect only when + `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space where + the density function will be computed. "soft" means the + span goes from the sample's minimum value minus two + bandwidths to the sample's maximum value plus two + bandwidths. "hard" means the span goes from the + sample's minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the `span` + attribute. + stream + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties + 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). + width + Sets the width of the violin in data coordinates. If 0 + (default value) the width is automatically selected + based on the positions of other violin traces in the + same subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Violin + + new_trace = Violin( + alignmentgroup=alignmentgroup, + bandwidth=bandwidth, + box=box, + customdata=customdata, + customdatasrc=customdatasrc, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + jitter=jitter, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meanline=meanline, + meta=meta, + metasrc=metasrc, + name=name, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + pointpos=pointpos, + points=points, + quartilemethod=quartilemethod, + scalegroup=scalegroup, + scalemode=scalemode, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + side=side, + span=span, + spanmode=spanmode, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + width=width, + x=x, + x0=x0, + xaxis=xaxis, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + yhoverformat=yhoverformat, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_volume( + self, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + opacityscale=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuehoverformat=None, + valuesrc=None, + visible=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "Figure": + """ + Add a new Volume trace + + Draws volume trace between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.volume.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties + spaceframe + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties + surface + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + Figure + """ + from plotly.graph_objs import Volume + + new_trace = Volume( + autocolorscale=autocolorscale, + caps=caps, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contour=contour, + customdata=customdata, + customdatasrc=customdatasrc, + flatshading=flatshading, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + isomax=isomax, + isomin=isomin, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + opacityscale=opacityscale, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + slices=slices, + spaceframe=spaceframe, + stream=stream, + surface=surface, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + value=value, + valuehoverformat=valuehoverformat, + valuesrc=valuesrc, + visible=visible, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_waterfall( + self, + alignmentgroup=None, + base=None, + cliponaxis=None, + connector=None, + constraintext=None, + customdata=None, + customdatasrc=None, + decreasing=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + measure=None, + measuresrc=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + totals=None, + uid=None, + uirevision=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Add a new Waterfall trace + + Draws waterfall trace which is useful graph to displays the + contribution of various elements (either positive or negative) + in a bar chart. The data visualized by the span of the bars is + set in `y` if `orientation` is set to "v" (the default) and the + labels are set in `x`. By setting `orientation` to "h", the + roles are interchanged. + + Parameters + ---------- + 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. + base + Sets where the bar base is drawn (in position axis + units). + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta` and `final`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.waterfall.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + measure + An array containing types of values. By default the + values are considered as 'relative'. However; it is + possible to use 'total' to compute the sums. Also + 'absolute' could be applied to reset the computed total + or to declare an initial value where needed. + measuresrc + Sets the source reference on Chart Studio Cloud for + `measure`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple waterfalls, totals are + computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta`, `final` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + totals + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + Figure + """ + from plotly.graph_objs import Waterfall + + new_trace = Waterfall( + alignmentgroup=alignmentgroup, + base=base, + cliponaxis=cliponaxis, + connector=connector, + constraintext=constraintext, + customdata=customdata, + customdatasrc=customdatasrc, + decreasing=decreasing, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + increasing=increasing, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + measure=measure, + measuresrc=measuresrc, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetgroup=offsetgroup, + offsetsrc=offsetsrc, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + totals=totals, + uid=uid, + uirevision=uirevision, + visible=visible, + width=width, + widthsrc=widthsrc, + x=x, + x0=x0, + xaxis=xaxis, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def select_coloraxes(self, selector=None, row=None, col=None): + """ + Select coloraxis subplot objects from a particular subplot cell + and/or coloraxis subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + coloraxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all coloraxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + coloraxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of coloraxis objects to select. + To select coloraxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all coloraxis objects are selected. + Returns + ------- + generator + Generator that iterates through all of the coloraxis + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("coloraxis", selector, row, col) + + def for_each_coloraxis(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all coloraxis objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single coloraxis object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + coloraxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all coloraxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + coloraxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of coloraxis objects to select. + To select coloraxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all coloraxis objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_coloraxes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_coloraxes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all coloraxis objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + coloraxis objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + coloraxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all coloraxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + coloraxis and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of coloraxis objects to select. + To select coloraxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all coloraxis objects are selected. + **kwargs + Additional property updates to apply to each selected + coloraxis object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_coloraxes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_geos(self, selector=None, row=None, col=None): + """ + Select geo subplot objects from a particular subplot cell + and/or geo subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + geo objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all geo objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + geo and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of geo objects to select. + To select geo objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all geo objects are selected. + Returns + ------- + generator + Generator that iterates through all of the geo + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("geo", selector, row, col) + + def for_each_geo(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all geo objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single geo object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + geo objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all geo objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + geo and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of geo objects to select. + To select geo objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all geo objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_geos(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_geos( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all geo objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + geo objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + geo objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all geo objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + geo and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of geo objects to select. + To select geo objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all geo objects are selected. + **kwargs + Additional property updates to apply to each selected + geo object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_geos(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_legends(self, selector=None, row=None, col=None): + """ + Select legend subplot objects from a particular subplot cell + and/or legend subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + legend objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all legend objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + legend and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of legend objects to select. + To select legend objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all legend objects are selected. + Returns + ------- + generator + Generator that iterates through all of the legend + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("legend", selector, row, col) + + def for_each_legend(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all legend objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single legend object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + legend objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all legend objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + legend and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of legend objects to select. + To select legend objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all legend objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_legends(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_legends( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all legend objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + legend objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + legend objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all legend objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + legend and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of legend objects to select. + To select legend objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all legend objects are selected. + **kwargs + Additional property updates to apply to each selected + legend object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_legends(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_maps(self, selector=None, row=None, col=None): + """ + Select map subplot objects from a particular subplot cell + and/or map subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + map objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all map objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + map and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of map objects to select. + To select map objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all map objects are selected. + Returns + ------- + generator + Generator that iterates through all of the map + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("map", selector, row, col) + + def for_each_map(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all map objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single map object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + map objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all map objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + map and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of map objects to select. + To select map objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all map objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_maps(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_maps( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all map objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + map objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + map objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all map objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + map and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of map objects to select. + To select map objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all map objects are selected. + **kwargs + Additional property updates to apply to each selected + map object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_maps(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_mapboxes(self, selector=None, row=None, col=None): + """ + Select mapbox subplot objects from a particular subplot cell + and/or mapbox subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + mapbox objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all mapbox objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + mapbox and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of mapbox objects to select. + To select mapbox objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all mapbox objects are selected. + Returns + ------- + generator + Generator that iterates through all of the mapbox + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("mapbox", selector, row, col) + + def for_each_mapbox(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all mapbox objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single mapbox object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + mapbox objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all mapbox objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + mapbox and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of mapbox objects to select. + To select mapbox objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all mapbox objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_mapboxes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_mapboxes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all mapbox objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + mapbox objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + mapbox objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all mapbox objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + mapbox and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of mapbox objects to select. + To select mapbox objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all mapbox objects are selected. + **kwargs + Additional property updates to apply to each selected + mapbox object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_mapboxes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_polars(self, selector=None, row=None, col=None): + """ + Select polar subplot objects from a particular subplot cell + and/or polar subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + polar objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all polar objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + polar and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of polar objects to select. + To select polar objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all polar objects are selected. + Returns + ------- + generator + Generator that iterates through all of the polar + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("polar", selector, row, col) + + def for_each_polar(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all polar objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single polar object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + polar objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all polar objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + polar and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of polar objects to select. + To select polar objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all polar objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_polars(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_polars( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all polar objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + polar objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + polar objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all polar objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + polar and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of polar objects to select. + To select polar objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all polar objects are selected. + **kwargs + Additional property updates to apply to each selected + polar object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_polars(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_scenes(self, selector=None, row=None, col=None): + """ + Select scene subplot objects from a particular subplot cell + and/or scene subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + scene objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all scene objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + scene and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of scene objects to select. + To select scene objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all scene objects are selected. + Returns + ------- + generator + Generator that iterates through all of the scene + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("scene", selector, row, col) + + def for_each_scene(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all scene objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single scene object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + scene objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all scene objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + scene and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of scene objects to select. + To select scene objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all scene objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_scenes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_scenes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all scene objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + scene objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + scene objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all scene objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + scene and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of scene objects to select. + To select scene objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all scene objects are selected. + **kwargs + Additional property updates to apply to each selected + scene object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_scenes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_smiths(self, selector=None, row=None, col=None): + """ + Select smith subplot objects from a particular subplot cell + and/or smith subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + smith objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all smith objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + smith and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of smith objects to select. + To select smith objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all smith objects are selected. + Returns + ------- + generator + Generator that iterates through all of the smith + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("smith", selector, row, col) + + def for_each_smith(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all smith objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single smith object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + smith objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all smith objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + smith and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of smith objects to select. + To select smith objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all smith objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_smiths(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_smiths( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all smith objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + smith objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + smith objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all smith objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + smith and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of smith objects to select. + To select smith objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all smith objects are selected. + **kwargs + Additional property updates to apply to each selected + smith object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_smiths(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_ternaries(self, selector=None, row=None, col=None): + """ + Select ternary subplot objects from a particular subplot cell + and/or ternary subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + ternary objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all ternary objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + ternary and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of ternary objects to select. + To select ternary objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all ternary objects are selected. + Returns + ------- + generator + Generator that iterates through all of the ternary + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("ternary", selector, row, col) + + def for_each_ternary(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all ternary objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single ternary object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + ternary objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all ternary objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + ternary and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of ternary objects to select. + To select ternary objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all ternary objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_ternaries(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_ternaries( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all ternary objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + ternary objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + ternary objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all ternary objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + ternary and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of ternary objects to select. + To select ternary objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all ternary objects are selected. + **kwargs + Additional property updates to apply to each selected + ternary object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_ternaries(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_xaxes(self, selector=None, row=None, col=None): + """ + Select xaxis subplot objects from a particular subplot cell + and/or xaxis subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + xaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all xaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + xaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of xaxis objects to select. + To select xaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all xaxis objects are selected. + Returns + ------- + generator + Generator that iterates through all of the xaxis + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("xaxis", selector, row, col) + + def for_each_xaxis(self, fn, selector=None, row=None, col=None) -> "Figure": + """ + Apply a function to all xaxis objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single xaxis object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + xaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all xaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + xaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of xaxis objects to select. + To select xaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all xaxis objects are selected. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_xaxes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_xaxes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all xaxis objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + xaxis objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + xaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all xaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + xaxis and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of xaxis objects to select. + To select xaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all xaxis objects are selected. + **kwargs + Additional property updates to apply to each selected + xaxis object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_xaxes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_yaxes(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select yaxis subplot objects from a particular subplot cell + and/or yaxis subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + yaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all yaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + yaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of yaxis objects to select. + To select yaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all yaxis objects are selected. + secondary_y: boolean or None (default None) + * If True, only select yaxis objects associated with the secondary + y-axis of the subplot. + * If False, only select yaxis objects associated with the primary + y-axis of the subplot. + * If None (the default), do not filter yaxis objects based on + a secondary y-axis condition. + + To select yaxis objects by secondary y-axis, the Figure must + have been created using plotly.subplots.make_subplots. See + the docstring for the specs argument to make_subplots for more + info on creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the yaxis + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix( + "yaxis", selector, row, col, secondary_y=secondary_y + ) + + def for_each_yaxis( + self, fn, selector=None, row=None, col=None, secondary_y=None + ) -> "Figure": + """ + Apply a function to all yaxis objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single yaxis object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + yaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all yaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + yaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of yaxis objects to select. + To select yaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all yaxis objects are selected. + secondary_y: boolean or None (default None) + * If True, only select yaxis objects associated with the secondary + y-axis of the subplot. + * If False, only select yaxis objects associated with the primary + y-axis of the subplot. + * If None (the default), do not filter yaxis objects based on + a secondary y-axis condition. + + To select yaxis objects by secondary y-axis, the Figure must + have been created using plotly.subplots.make_subplots. See + the docstring for the specs argument to make_subplots for more + info on creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_yaxes( + selector=selector, row=row, col=col, secondary_y=secondary_y + ): + fn(obj) + + return self + + def update_yaxes( + self, + patch=None, + selector=None, + overwrite=False, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "Figure": + """ + Perform a property update operation on all yaxis objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + yaxis objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + yaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all yaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + yaxis and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of yaxis objects to select. + To select yaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all yaxis objects are selected. + secondary_y: boolean or None (default None) + * If True, only select yaxis objects associated with the secondary + y-axis of the subplot. + * If False, only select yaxis objects associated with the primary + y-axis of the subplot. + * If None (the default), do not filter yaxis objects based on + a secondary y-axis condition. + + To select yaxis objects by secondary y-axis, the Figure must + have been created using plotly.subplots.make_subplots. See + the docstring for the specs argument to make_subplots for more + info on creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected + yaxis object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self.select_yaxes( + selector=selector, row=row, col=col, secondary_y=secondary_y + ): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_annotations(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select annotations from a particular subplot cell and/or annotations + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all annotations are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each annotation and those for which the function returned True + will be in the selection. If an int N, the Nth annotation matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of annotations to select. + To select annotations by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + annotation that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all annotations are selected. + secondary_y: boolean or None (default None) + * If True, only select annotations associated with the secondary + y-axis of the subplot. + * If False, only select annotations associated with the primary + y-axis of the subplot. + * If None (the default), do not filter annotations based on secondary + y-axis. + + To select annotations by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the annotations that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "annotations", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_annotation( + self, fn, selector=None, row=None, col=None, secondary_y=None + ): + """ + Apply a function to all annotations that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single annotation object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all annotations are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each annotation and those for which the function returned True + will be in the selection. If an int N, the Nth annotation matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of annotations to select. + To select annotations by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + annotations that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all annotations are selected. + secondary_y: boolean or None (default None) + * If True, only select annotations associated with the secondary + y-axis of the subplot. + * If False, only select annotations associated with the primary + y-axis of the subplot. + * If None (the default), do not filter annotations based on secondary + y-axis. + + To select annotations by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="annotations", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_annotations( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all annotations that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all annotations that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all annotations are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each annotation and those for which the function returned True + will be in the selection. If an int N, the Nth annotation matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of annotations to select. + To select annotations by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + annotation that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all annotations are selected. + secondary_y: boolean or None (default None) + * If True, only select annotations associated with the secondary + y-axis of the subplot. + * If False, only select annotations associated with the primary + y-axis of the subplot. + * If None (the default), do not filter annotations based on secondary + y-axis. + + To select annotations by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected annotation. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="annotations", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_annotation( + self, + arg=None, + align=None, + arrowcolor=None, + arrowhead=None, + arrowside=None, + arrowsize=None, + arrowwidth=None, + ax=None, + axref=None, + ay=None, + ayref=None, + bgcolor=None, + bordercolor=None, + borderpad=None, + borderwidth=None, + captureevents=None, + clicktoshow=None, + font=None, + height=None, + hoverlabel=None, + hovertext=None, + name=None, + opacity=None, + showarrow=None, + standoff=None, + startarrowhead=None, + startarrowsize=None, + startstandoff=None, + templateitemname=None, + text=None, + textangle=None, + valign=None, + visible=None, + width=None, + x=None, + xanchor=None, + xclick=None, + xref=None, + xshift=None, + y=None, + yanchor=None, + yclick=None, + yref=None, + yshift=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "Figure": + """ + Create and add a new annotation to the figure's layout + + Parameters + ---------- + arg + instance of Annotation or dict with compatible + properties + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head. If `axref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from right + to left (left to right). If `axref` is not `pixel` and + is exactly the same as `xref`, this is an absolute + value on that axis, like `x`, specified in the same + coordinates as `xref`. + axref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. In order for absolute + positioning of the arrow to work, "axref" must be + exactly the same as "xref", otherwise "axref" will + revert to "pixel" (explained next). For relative + positioning, "axref" can be set to "pixel", in which + case the "ax" value is specified in pixels relative to + "x". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + ay + Sets the y component of the arrow tail about the arrow + head. If `ayref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from bottom + to top (top to bottom). If `ayref` is not `pixel` and + is exactly the same as `yref`, this is an absolute + value on that axis, like `y`, specified in the same + coordinates as `yref`. + ayref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. In order for absolute + positioning of the arrow to work, "ayref" must be + exactly the same as "yref", otherwise "ayref" will + revert to "pixel" (explained next). For relative + positioning, "ayref" can be set to "pixel", in which + case the "ay" value is specified in pixels relative to + "y". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the plot. If + you click a data point that exactly matches the `x` and + `y` values of this annotation, and it is hidden + (visible: false), it will appear. In "onoff" mode, you + must click the same point again to make it disappear, + so if you click multiple points, you can show multiple + annotations. In "onout" mode, a click anywhere else in + the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for example to + label the side of a bar. To label markers though, + `standoff` is preferred over `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xclick + Toggle this annotation when clicking a data point whose + `x` value is `xclick` rather than the annotation's `x` + value. + xref + Sets the annotation's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yclick + Toggle this annotation when clicking a data point whose + `y` value is `yclick` rather than the annotation's `y` + value. + yref + Sets the annotation's y coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + row + Subplot row for annotation. If 'all', addresses all + rows in the specified column(s). + col + Subplot column for annotation. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add annotation to secondary y-axis + exclude_empty_subplots + If True, annotation will not be added to subplots + without traces. + + Returns + ------- + Figure + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Annotation( + arg, + align=align, + arrowcolor=arrowcolor, + arrowhead=arrowhead, + arrowside=arrowside, + arrowsize=arrowsize, + arrowwidth=arrowwidth, + ax=ax, + axref=axref, + ay=ay, + ayref=ayref, + bgcolor=bgcolor, + bordercolor=bordercolor, + borderpad=borderpad, + borderwidth=borderwidth, + captureevents=captureevents, + clicktoshow=clicktoshow, + font=font, + height=height, + hoverlabel=hoverlabel, + hovertext=hovertext, + name=name, + opacity=opacity, + showarrow=showarrow, + standoff=standoff, + startarrowhead=startarrowhead, + startarrowsize=startarrowsize, + startstandoff=startstandoff, + templateitemname=templateitemname, + text=text, + textangle=textangle, + valign=valign, + visible=visible, + width=width, + x=x, + xanchor=xanchor, + xclick=xclick, + xref=xref, + xshift=xshift, + y=y, + yanchor=yanchor, + yclick=yclick, + yref=yref, + yshift=yshift, + **kwargs, + ) + return self._add_annotation_like( + "annotation", + "annotations", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) + + def select_layout_images(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select images from a particular subplot cell and/or images + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all images are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each image and those for which the function returned True + will be in the selection. If an int N, the Nth image matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of images to select. + To select images by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + image that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all images are selected. + secondary_y: boolean or None (default None) + * If True, only select images associated with the secondary + y-axis of the subplot. + * If False, only select images associated with the primary + y-axis of the subplot. + * If None (the default), do not filter images based on secondary + y-axis. + + To select images by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the images that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "images", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_layout_image( + self, fn, selector=None, row=None, col=None, secondary_y=None + ): + """ + Apply a function to all images that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single image object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all images are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each image and those for which the function returned True + will be in the selection. If an int N, the Nth image matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of images to select. + To select images by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + images that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all images are selected. + secondary_y: boolean or None (default None) + * If True, only select images associated with the secondary + y-axis of the subplot. + * If False, only select images associated with the primary + y-axis of the subplot. + * If None (the default), do not filter images based on secondary + y-axis. + + To select images by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="images", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_layout_images( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all images that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all images that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all images are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each image and those for which the function returned True + will be in the selection. If an int N, the Nth image matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of images to select. + To select images by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + image that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all images are selected. + secondary_y: boolean or None (default None) + * If True, only select images associated with the secondary + y-axis of the subplot. + * If False, only select images associated with the primary + y-axis of the subplot. + * If None (the default), do not filter images based on secondary + y-axis. + + To select images by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected image. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="images", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_layout_image( + self, + arg=None, + layer=None, + name=None, + opacity=None, + sizex=None, + sizey=None, + sizing=None, + source=None, + templateitemname=None, + visible=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "Figure": + """ + Create and add a new image to the figure's layout + + Parameters + ---------- + arg + instance of Image or dict with compatible properties + layer + Specifies whether images are drawn below or above + traces. When `xref` and `yref` are both set to `paper`, + image is drawn below the entire plot area. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The image + will be sized based on the `position` value. When + `xref` is set to `paper`, units are sized relative to + the plot width. When `xref` ends with ` domain`, units + are sized relative to the axis width. + sizey + Sets the image container size vertically. The image + will be sized based on the `position` value. When + `yref` is set to `paper`, units are sized relative to + the plot height. When `yref` ends with ` domain`, units + are sized relative to the axis height. + sizing + Specifies which dimension of the image to constrain. + source + Specifies the URL of the image to be used. The URL must + be accessible from the domain where the plot code is + run, and can be either relative or absolute. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this image is visible. + x + Sets the image's x position. When `xref` is set to + `paper`, units are sized relative to the plot height. + See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y + Sets the image's y position. When `yref` is set to + `paper`, units are sized relative to the plot height. + See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + row + Subplot row for image. If 'all', addresses all rows in + the specified column(s). + col + Subplot column for image. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add image to secondary y-axis + exclude_empty_subplots + If True, image will not be added to subplots without + traces. + + Returns + ------- + Figure + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Image( + arg, + layer=layer, + name=name, + opacity=opacity, + sizex=sizex, + sizey=sizey, + sizing=sizing, + source=source, + templateitemname=templateitemname, + visible=visible, + x=x, + xanchor=xanchor, + xref=xref, + y=y, + yanchor=yanchor, + yref=yref, + **kwargs, + ) + return self._add_annotation_like( + "image", + "images", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) + + def select_selections(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select selections from a particular subplot cell and/or selections + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all selections are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each selection and those for which the function returned True + will be in the selection. If an int N, the Nth selection matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of selections to select. + To select selections by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + selection that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all selections are selected. + secondary_y: boolean or None (default None) + * If True, only select selections associated with the secondary + y-axis of the subplot. + * If False, only select selections associated with the primary + y-axis of the subplot. + * If None (the default), do not filter selections based on secondary + y-axis. + + To select selections by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the selections that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "selections", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_selection( + self, fn, selector=None, row=None, col=None, secondary_y=None + ): + """ + Apply a function to all selections that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single selection object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all selections are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each selection and those for which the function returned True + will be in the selection. If an int N, the Nth selection matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of selections to select. + To select selections by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + selections that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all selections are selected. + secondary_y: boolean or None (default None) + * If True, only select selections associated with the secondary + y-axis of the subplot. + * If False, only select selections associated with the primary + y-axis of the subplot. + * If None (the default), do not filter selections based on secondary + y-axis. + + To select selections by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="selections", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_selections( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all selections that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all selections that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all selections are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each selection and those for which the function returned True + will be in the selection. If an int N, the Nth selection matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of selections to select. + To select selections by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + selection that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all selections are selected. + secondary_y: boolean or None (default None) + * If True, only select selections associated with the secondary + y-axis of the subplot. + * If False, only select selections associated with the primary + y-axis of the subplot. + * If None (the default), do not filter selections based on secondary + y-axis. + + To select selections by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected selection. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="selections", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_selection( + self, + arg=None, + line=None, + name=None, + opacity=None, + path=None, + templateitemname=None, + type=None, + x0=None, + x1=None, + xref=None, + y0=None, + y1=None, + yref=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "Figure": + """ + Create and add a new selection to the figure's layout + + Parameters + ---------- + arg + instance of Selection or dict with compatible + properties + line + :class:`plotly.graph_objects.layout.selection.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the selection. + path + For `type` "path" - a valid SVG path similar to + `shapes.path` in data coordinates. Allowed segments + are: M, L and Z. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the selection type to be drawn. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom + SVG path using `path`. + x0 + Sets the selection's starting x position. + x1 + Sets the selection's end x position. + xref + Sets the selection's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y0 + Sets the selection's starting y position. + y1 + Sets the selection's end y position. + yref + Sets the selection's x coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + row + Subplot row for selection. If 'all', addresses all rows + in the specified column(s). + col + Subplot column for selection. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add selection to secondary y-axis + exclude_empty_subplots + If True, selection will not be added to subplots + without traces. + + Returns + ------- + Figure + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Selection( + arg, + line=line, + name=name, + opacity=opacity, + path=path, + templateitemname=templateitemname, + type=type, + x0=x0, + x1=x1, + xref=xref, + y0=y0, + y1=y1, + yref=yref, + **kwargs, + ) + return self._add_annotation_like( + "selection", + "selections", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) + + def select_shapes(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select shapes from a particular subplot cell and/or shapes + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all shapes are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each shape and those for which the function returned True + will be in the selection. If an int N, the Nth shape matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of shapes to select. + To select shapes by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + shape that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all shapes are selected. + secondary_y: boolean or None (default None) + * If True, only select shapes associated with the secondary + y-axis of the subplot. + * If False, only select shapes associated with the primary + y-axis of the subplot. + * If None (the default), do not filter shapes based on secondary + y-axis. + + To select shapes by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the shapes that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "shapes", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_shape(self, fn, selector=None, row=None, col=None, secondary_y=None): + """ + Apply a function to all shapes that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single shape object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all shapes are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each shape and those for which the function returned True + will be in the selection. If an int N, the Nth shape matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of shapes to select. + To select shapes by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + shapes that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all shapes are selected. + secondary_y: boolean or None (default None) + * If True, only select shapes associated with the secondary + y-axis of the subplot. + * If False, only select shapes associated with the primary + y-axis of the subplot. + * If None (the default), do not filter shapes based on secondary + y-axis. + + To select shapes by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="shapes", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_shapes( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "Figure": + """ + Perform a property update operation on all shapes that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all shapes that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all shapes are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each shape and those for which the function returned True + will be in the selection. If an int N, the Nth shape matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of shapes to select. + To select shapes by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + shape that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all shapes are selected. + secondary_y: boolean or None (default None) + * If True, only select shapes associated with the secondary + y-axis of the subplot. + * If False, only select shapes associated with the primary + y-axis of the subplot. + * If None (the default), do not filter shapes based on secondary + y-axis. + + To select shapes by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected shape. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the Figure object that the method was called on + """ + for obj in self._select_annotations_like( + prop="shapes", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_shape( + self, + arg=None, + editable=None, + fillcolor=None, + fillrule=None, + label=None, + layer=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + name=None, + opacity=None, + path=None, + showlegend=None, + templateitemname=None, + type=None, + visible=None, + x0=None, + x0shift=None, + x1=None, + x1shift=None, + xanchor=None, + xref=None, + xsizemode=None, + y0=None, + y0shift=None, + y1=None, + y1shift=None, + yanchor=None, + yref=None, + ysizemode=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "Figure": + """ + Create and add a new shape to the figure's layout + + Parameters + ---------- + arg + instance of Shape or dict with compatible properties + editable + Determines whether the shape could be activated for + edit or not. Has no effect when the older editable + shapes mode is enabled via `config.editable` or + `config.edits.shapePosition`. + fillcolor + Sets the color filling the shape's interior. Only + applies to closed shapes. + fillrule + Determines which regions of complex paths constitute + the interior. For more info please visit + https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + label + :class:`plotly.graph_objects.layout.shape.Label` + instance or dict with compatible properties + layer + Specifies whether shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or + above traces ("above"). + legend + Sets the reference to a legend to show this shape in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this shape. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.layout.shape.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this shape. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this shape. + line + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the pixel + values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and taken + unmodified as pixels relative to `xanchor` and + `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not + relative. So the allowed segments are: M, L, H, V, Q, + C, T, S, and Z arcs (A) are not allowed because radius + rx and ry are relative. In the future we could consider + supporting relative commands, but we would have to + decide on how to handle date and log axes. Note that + even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. + no chained "polybezier" commands - specify the segment + type for each one. On category axes, values are numbers + scaled to the serial numbers of categories because + using the categories themselves there would be no way + to describe fractional positions On data axes: because + space and T are both normal components of path strings, + we can't use either to separate date from time parts. + Therefore we'll use underscore for this purpose: + 2015-02-21_13:45:56.789 + showlegend + Determines whether or not this shape is shown in the + legend. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If "line", a line + is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect + to the axes' sizing mode. If "circle", a circle is + drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with + respect to the axes' sizing mode. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to + the axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' sizing + mode. + visible + Determines whether or not this shape is visible. If + "legendonly", the shape is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x0 + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + x0shift + Shifts `x0` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + x1shift + Shifts `x1` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + xanchor + Only relevant in conjunction with `xsizemode` set to + "pixel". Specifies the anchor point on the x axis to + which `x0`, `x1` and x coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `xsizemode` not + set to "pixel". + xref + Sets the shape's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xsizemode + Sets the shapes's sizing mode along the x axis. If set + to "scaled", `x0`, `x1` and x coordinates within `path` + refer to data values on the x axis or a fraction of the + plot area's width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in terms of + data or plot fraction but `x0`, `x1` and x coordinates + within `path` are pixels relative to `xanchor`. This + way, the shape can have a fixed width while maintaining + a position relative to data or plot fraction. + y0 + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + y0shift + Shifts `y0` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + y1shift + Shifts `y1` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + yanchor + Only relevant in conjunction with `ysizemode` set to + "pixel". Specifies the anchor point on the y axis to + which `y0`, `y1` and y coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `ysizemode` not + set to "pixel". + yref + Sets the shape's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + ysizemode + Sets the shapes's sizing mode along the y axis. If set + to "scaled", `y0`, `y1` and y coordinates within `path` + refer to data values on the y axis or a fraction of the + plot area's height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in terms of + data or plot fraction but `y0`, `y1` and y coordinates + within `path` are pixels relative to `yanchor`. This + way, the shape can have a fixed height while + maintaining a position relative to data or plot + fraction. + row + Subplot row for shape. If 'all', addresses all rows in + the specified column(s). + col + Subplot column for shape. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add shape to secondary y-axis + exclude_empty_subplots + If True, shape will not be added to subplots without + traces. + + Returns + ------- + Figure + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Shape( + arg, + editable=editable, + fillcolor=fillcolor, + fillrule=fillrule, + label=label, + layer=layer, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + name=name, + opacity=opacity, + path=path, + showlegend=showlegend, + templateitemname=templateitemname, + type=type, + visible=visible, + x0=x0, + x0shift=x0shift, + x1=x1, + x1shift=x1shift, + xanchor=xanchor, + xref=xref, + xsizemode=xsizemode, + y0=y0, + y0shift=y0shift, + y1=y1, + y1shift=y1shift, + yanchor=yanchor, + yref=yref, + ysizemode=ysizemode, + **kwargs, + ) + return self._add_annotation_like( + "shape", + "shapes", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_figurewidget.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_figurewidget.py new file mode 100644 index 0000000..9731635 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_figurewidget.py @@ -0,0 +1,24437 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basewidget import BaseFigureWidget + + +class FigureWidget(BaseFigureWidget): + def __init__( + self, data=None, layout=None, frames=None, skip_invalid=False, **kwargs + ): + """ + Create a new :class:FigureWidget instance + + Parameters + ---------- + data + The 'data' property is a tuple of trace instances + that may be specified as: + - A list or tuple of trace instances + (e.g. [Scatter(...), Bar(...)]) + - A single trace instance + (e.g. Scatter(...), Bar(...), etc.) + - A list or tuple of dicts of string/value properties where: + - The 'type' property specifies the trace type + One of: ['bar', 'barpolar', 'box', 'candlestick', + 'carpet', 'choropleth', 'choroplethmap', + 'choroplethmapbox', 'cone', 'contour', + 'contourcarpet', 'densitymap', + 'densitymapbox', 'funnel', 'funnelarea', + 'heatmap', 'histogram', 'histogram2d', + 'histogram2dcontour', 'icicle', 'image', + 'indicator', 'isosurface', 'mesh3d', 'ohlc', + 'parcats', 'parcoords', 'pie', 'sankey', + 'scatter', 'scatter3d', 'scattercarpet', + 'scattergeo', 'scattergl', 'scattermap', + 'scattermapbox', 'scatterpolar', + 'scatterpolargl', 'scattersmith', + 'scatterternary', 'splom', 'streamtube', + 'sunburst', 'surface', 'table', 'treemap', + 'violin', 'volume', 'waterfall'] + + - All remaining properties are passed to the constructor of + the specified trace type + + (e.g. [{'type': 'scatter', ...}, {'type': 'bar, ...}]) + + layout + The 'layout' property is an instance of Layout + that may be specified as: + - An instance of :class:`plotly.graph_objs.Layout` + - A dict of string/value properties that will be passed + to the Layout constructor + + frames + The 'frames' property is a tuple of instances of + Frame that may be specified as: + - A list or tuple of instances of plotly.graph_objs.Frame + - A list or tuple of dicts of string/value properties that + will be passed to the Frame constructor + + skip_invalid: bool + 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 + + Raises + ------ + ValueError + if a property in the specification of data, layout, or frames + is invalid AND skip_invalid is False + """ + super().__init__(data, layout, frames, skip_invalid, **kwargs) + + def update(self, dict1=None, overwrite=False, **kwargs) -> "FigureWidget": + """ + + Update the properties of the figure with a dict and/or with + keyword arguments. + + This recursively updates the structure of the figure + object with the values in the input dict / keyword arguments. + + Parameters + ---------- + dict1 : dict + Dictionary of properties to be updated + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + kwargs : + Keyword/value pair of properties to be updated + + Examples + -------- + >>> import plotly.graph_objs as go + >>> fig = go.Figure(data=[{'y': [1, 2, 3]}]) + >>> fig.update(data=[{'y': [4, 5, 6]}]) # doctest: +ELLIPSIS + Figure(...) + >>> fig.to_plotly_json() # doctest: +SKIP + {'data': [{'type': 'scatter', + 'uid': 'e86a7c7a-346a-11e8-8aa8-a0999b0c017b', + 'y': array([4, 5, 6], dtype=int32)}], + 'layout': {}} + + >>> fig = go.Figure(layout={'xaxis': + ... {'color': 'green', + ... 'range': [0, 1]}}) + >>> fig.update({'layout': {'xaxis': {'color': 'pink'}}}) # doctest: +ELLIPSIS + Figure(...) + >>> fig.to_plotly_json() # doctest: +SKIP + {'data': [], + 'layout': {'xaxis': + {'color': 'pink', + 'range': [0, 1]}}} + + Returns + ------- + BaseFigure + Updated figure + + """ + return super().update(dict1, overwrite, **kwargs) + + def update_traces( + self, + patch=None, + selector=None, + row=None, + col=None, + secondary_y=None, + overwrite=False, + **kwargs, + ) -> "FigureWidget": + """ + + Perform a property update operation on all traces that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all traces that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all traces are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each trace and those for which the function returned True + will be in the selection. If an int N, the Nth trace matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of traces to select. + To select traces by row and column, the Figure must have been + created using plotly.subplots.make_subplots. If None + (the default), all traces are selected. + secondary_y: boolean or None (default None) + * If True, only select traces associated with the secondary + y-axis of the subplot. + * If False, only select traces associated with the primary + y-axis of the subplot. + * If None (the default), do not filter traces based on secondary + y-axis. + + To select traces by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + **kwargs + Additional property updates to apply to each selected trace. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the Figure object that the method was called on + + """ + return super().update_traces( + patch, selector, row, col, secondary_y, overwrite, **kwargs + ) + + def update_layout(self, dict1=None, overwrite=False, **kwargs) -> "FigureWidget": + """ + + Update the properties of the figure's layout with a dict and/or with + keyword arguments. + + This recursively updates the structure of the original + layout with the values in the input dict / keyword arguments. + + Parameters + ---------- + dict1 : dict + Dictionary of properties to be updated + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + kwargs : + Keyword/value pair of properties to be updated + + Returns + ------- + BaseFigure + The Figure object that the update_layout method was called on + + """ + return super().update_layout(dict1, overwrite, **kwargs) + + def for_each_trace( + self, fn, selector=None, row=None, col=None, secondary_y=None + ) -> "FigureWidget": + """ + + Apply a function to all traces that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single trace object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all traces are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each trace and those for which the function returned True + will be in the selection. If an int N, the Nth trace matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of traces to select. + To select traces by row and column, the Figure must have been + created using plotly.subplots.make_subplots. If None + (the default), all traces are selected. + secondary_y: boolean or None (default None) + * If True, only select traces associated with the secondary + y-axis of the subplot. + * If False, only select traces associated with the primary + y-axis of the subplot. + * If None (the default), do not filter traces based on secondary + y-axis. + + To select traces by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the Figure object that the method was called on + + """ + return super().for_each_trace(fn, selector, row, col, secondary_y) + + def add_trace( + self, trace, row=None, col=None, secondary_y=None, exclude_empty_subplots=False + ) -> "FigureWidget": + """ + + Add a trace to the figure + + Parameters + ---------- + trace : BaseTraceType or dict + Either: + - An instances of a trace classe from the plotly.graph_objs + package (e.g plotly.graph_objs.Scatter, plotly.graph_objs.Bar) + - or a dicts where: + + - The 'type' property specifies the trace type (e.g. + 'scatter', 'bar', 'area', etc.). If the dict has no 'type' + property then 'scatter' is assumed. + - All remaining properties are passed to the constructor + of the specified trace type. + + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`. + If 'all', addresses all rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`. + If 'all', addresses all columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + * The trace argument is a 2D cartesian trace + (scatter, bar, etc.) + exclude_empty_subplots: boolean + If True, the trace will not be added to subplots that don't already + have traces. + Returns + ------- + BaseFigure + The Figure that add_trace was called on + + Examples + -------- + + >>> from plotly import subplots + >>> import plotly.graph_objs as go + + Add two Scatter traces to a figure + + >>> fig = go.Figure() + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS + Figure(...) + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2])) # doctest: +ELLIPSIS + Figure(...) + + + Add two Scatter traces to vertically stacked subplots + + >>> fig = subplots.make_subplots(rows=2) + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=1, col=1) # doctest: +ELLIPSIS + Figure(...) + >>> fig.add_trace(go.Scatter(x=[1,2,3], y=[2,1,2]), row=2, col=1) # doctest: +ELLIPSIS + Figure(...) + + """ + return super().add_trace(trace, row, col, secondary_y, exclude_empty_subplots) + + def add_traces( + self, + data, + rows=None, + cols=None, + secondary_ys=None, + exclude_empty_subplots=False, + ) -> "FigureWidget": + """ + + Add traces to the figure + + Parameters + ---------- + data : list[BaseTraceType or dict] + A list of trace specifications to be added. + Trace specifications may be either: + + - Instances of trace classes from the plotly.graph_objs + package (e.g plotly.graph_objs.Scatter, plotly.graph_objs.Bar) + - Dicts where: + + - The 'type' property specifies the trace type (e.g. + 'scatter', 'bar', 'area', etc.). If the dict has no 'type' + property then 'scatter' is assumed. + - All remaining properties are passed to the constructor + of the specified trace type. + + rows : None, list[int], or int (default None) + List of subplot row indexes (starting from 1) for the traces to be + added. Only valid if figure was created using + `plotly.tools.make_subplots` + If a single integer is passed, all traces will be added to row number + + cols : None or list[int] (default None) + List of subplot column indexes (starting from 1) for the traces + to be added. Only valid if figure was created using + `plotly.tools.make_subplots` + If a single integer is passed, all traces will be added to column number + + + secondary_ys: None or list[boolean] (default None) + List of secondary_y booleans for traces to be added. See the + docstring for `add_trace` for more info. + + exclude_empty_subplots: boolean + If True, the trace will not be added to subplots that don't already + have traces. + + Returns + ------- + BaseFigure + The Figure that add_traces was called on + + Examples + -------- + + >>> from plotly import subplots + >>> import plotly.graph_objs as go + + Add two Scatter traces to a figure + + >>> fig = go.Figure() + >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]), + ... go.Scatter(x=[1,2,3], y=[2,1,2])]) # doctest: +ELLIPSIS + Figure(...) + + Add two Scatter traces to vertically stacked subplots + + >>> fig = subplots.make_subplots(rows=2) + >>> fig.add_traces([go.Scatter(x=[1,2,3], y=[2,1,2]), + ... go.Scatter(x=[1,2,3], y=[2,1,2])], + ... rows=[1, 2], cols=[1, 1]) # doctest: +ELLIPSIS + Figure(...) + + """ + return super().add_traces( + data, rows, cols, secondary_ys, exclude_empty_subplots + ) + + def add_vline( + self, + x, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "FigureWidget": + """ + + Add a vertical line to a plot or subplot that extends infinitely in the + y-dimension. + + Parameters + ---------- + x: float or int + A number representing the x coordinate of the vertical line. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the line. Example positions are "bottom left", "right top", + "right", "bottom". If an annotation is added but annotation_position is + not specified, this defaults to "top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_vline( + x, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def add_hline( + self, + y, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "FigureWidget": + """ + + Add a horizontal line to a plot or subplot that extends infinitely in the + x-dimension. + + Parameters + ---------- + y: float or int + A number representing the y coordinate of the horizontal line. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the line. Example positions are "bottom left", "right top", + "right", "bottom". If an annotation is added but annotation_position is + not specified, this defaults to "top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_hline( + y, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def add_vrect( + self, + x0, + x1, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "FigureWidget": + """ + + Add a rectangle to a plot or subplot that extends infinitely in the + y-dimension. + + Parameters + ---------- + x0: float or int + A number representing the x coordinate of one side of the rectangle. + x1: float or int + A number representing the x coordinate of the other side of the rectangle. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the rectangle. Example positions are "outside top left", "inside + bottom", "right", "inside left", "inside" ("outside" is not supported). If + an annotation is added but annotation_position is not specified this + defaults to "inside top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_vrect( + x0, x1, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def add_hrect( + self, + y0, + y1, + row="all", + col="all", + exclude_empty_subplots=True, + annotation=None, + **kwargs, + ) -> "FigureWidget": + """ + + Add a rectangle to a plot or subplot that extends infinitely in the + x-dimension. + + Parameters + ---------- + y0: float or int + A number representing the y coordinate of one side of the rectangle. + y1: float or int + A number representing the y coordinate of the other side of the rectangle. + exclude_empty_subplots: Boolean + If True (default) do not place the shape on subplots that have no data + plotted on them. + row: None, int or 'all' + Subplot row for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + col: None, int or 'all' + Subplot column for shape indexed starting at 1. If 'all', addresses all rows in + the specified column(s). If both row and col are None, addresses the + first subplot if subplots exist, or the only plot. By default is "all". + annotation: dict or plotly.graph_objects.layout.Annotation. If dict(), + it is interpreted as describing an annotation. The annotation is + placed relative to the shape based on annotation_position (see + below) unless its x or y value has been specified for the annotation + passed here. xref and yref are always the same as for the added + shape and cannot be overridden. + annotation_position: a string containing optionally ["inside", "outside"], ["top", "bottom"] + and ["left", "right"] specifying where the text should be anchored + to on the rectangle. Example positions are "outside top left", "inside + bottom", "right", "inside left", "inside" ("outside" is not supported). If + an annotation is added but annotation_position is not specified this + defaults to "inside top right". + annotation_*: any parameters to go.layout.Annotation can be passed as + keywords by prefixing them with "annotation_". For example, to specify the + annotation text "example" you can pass annotation_text="example" as a + keyword argument. + **kwargs: + Any named function parameters that can be passed to 'add_shape', + except for x0, x1, y0, y1 or type. + """ + return super().add_hrect( + y0, y1, row, col, exclude_empty_subplots, annotation, **kwargs + ) + + def set_subplots( + self, rows=None, cols=None, **make_subplots_args + ) -> "FigureWidget": + """ + + Add subplots to this figure. If the figure already contains subplots, + then this throws an error. Accepts any keyword arguments that + plotly.subplots.make_subplots accepts. + + """ + return super().set_subplots(rows, cols, **make_subplots_args) + + def add_bar( + self, + alignmentgroup=None, + base=None, + basesrc=None, + cliponaxis=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Bar trace + + The data visualized by the span of the bars is set in `y` if + `orientation` is set to "v" (the default) and the labels are + set in `x`. By setting `orientation` to "h", the roles are + interchanged. + + Parameters + ---------- + 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. + base + Sets where the bar base is drawn (in position axis + units). In "stack" or "relative" barmode, traces that + set "base" will be excluded and drawn in "overlay" mode + instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.bar.ErrorX` instance or + dict with compatible properties + error_y + :class:`plotly.graph_objects.bar.ErrorY` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.bar.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.bar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.bar.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.bar.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.bar.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `value` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.bar.Unselected` instance + or dict with compatible properties + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Bar + + new_trace = Bar( + alignmentgroup=alignmentgroup, + base=base, + basesrc=basesrc, + cliponaxis=cliponaxis, + constraintext=constraintext, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + error_x=error_x, + error_y=error_y, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetgroup=offsetgroup, + offsetsrc=offsetsrc, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + width=width, + widthsrc=widthsrc, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_barpolar( + self, + base=None, + basesrc=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetsrc=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + widthsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Barpolar trace + + The data visualized by the radial span of the bars is set in + `r` + + Parameters + ---------- + base + Sets where the bar base is drawn (in radial axis + units). In "stack" barmode, traces that set "base" will + be excluded and drawn in "overlay" mode instead. + basesrc + Sets the source reference on Chart Studio Cloud for + `base`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.barpolar.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.barpolar.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.barpolar.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the angular position where the bar is drawn (in + "thetatunit" units). + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.barpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.barpolar.Stream` instance + or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + 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. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.barpolar.Unselected` + instance or dict with compatible properties + 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). + width + Sets the bar angular width (in "thetaunit" units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Barpolar + + new_trace = Barpolar( + base=base, + basesrc=basesrc, + customdata=customdata, + customdatasrc=customdatasrc, + dr=dr, + dtheta=dtheta, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetsrc=offsetsrc, + opacity=opacity, + r=r, + r0=r0, + rsrc=rsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + theta=theta, + theta0=theta0, + thetasrc=thetasrc, + thetaunit=thetaunit, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + width=width, + widthsrc=widthsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_box( + self, + alignmentgroup=None, + boxmean=None, + boxpoints=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lowerfence=None, + lowerfencesrc=None, + marker=None, + mean=None, + meansrc=None, + median=None, + mediansrc=None, + meta=None, + metasrc=None, + name=None, + notched=None, + notchspan=None, + notchspansrc=None, + notchwidth=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + q1=None, + q1src=None, + q3=None, + q3src=None, + quartilemethod=None, + sd=None, + sdmultiple=None, + sdsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + showwhiskers=None, + sizemode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + upperfence=None, + upperfencesrc=None, + visible=None, + whiskerwidth=None, + width=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Box trace + + Each box spans from quartile 1 (Q1) to quartile 3 (Q3). The + second quartile (Q2, i.e. the median) is marked by a line + inside the box. The fences grow outward from the boxes' edges, + by default they span +/- 1.5 times the interquartile range + (IQR: Q3-Q1), The sample mean and standard deviation as well as + notches and the sample, outlier and suspected outliers points + can be optionally added to the box plot. The values and + positions corresponding to each boxes can be input using two + signatures. The first signature expects users to supply the + sample values in the `y` data array for vertical boxes (`x` for + horizontal boxes). By supplying an `x` (`y`) array, one box per + distinct `x` (`y`) value is drawn If no `x` (`y`) list is + provided, a single box is drawn. In this case, the box is + positioned with the trace `name` or with `x0` (`y0`) if + provided. The second signature expects users to supply the + boxes corresponding Q1, median and Q3 statistics in the `q1`, + `median` and `q3` data arrays respectively. Other box features + relying on statistics namely `lowerfence`, `upperfence`, + `notchspan` can be set directly by the users. To have plotly + compute them or to show sample points besides the boxes, users + can set the `y` data array for vertical boxes (`x` for + horizontal boxes) to a 2D array with the outer length + corresponding to the number of boxes in the traces and the + inner length corresponding the sample size. + + Parameters + ---------- + 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. + boxmean + If True, the mean of the box(es)' underlying + distribution is drawn as a dashed line inside the + box(es). If "sd" the standard deviation is also drawn. + Defaults to True when `mean` is set. Defaults to "sd" + when `sd` is set Otherwise defaults to False. + boxpoints + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the box(es) are shown with no sample + points Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set. Defaults to "all" under the q1/median/q3 + signature. Otherwise defaults to "outliers". + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step for multi-box traces set + using q1/median/q3. + dy + Sets the y coordinate step for multi-box traces set + using q1/median/q3. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.box.Hoverlabel` instance + or dict with compatible properties + hoveron + Do the hover effects highlight individual boxes or + sample points or both? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the box(es). + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.box.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.box.Line` instance or dict + with compatible properties + lowerfence + Sets the lower fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `lowerfence` is not provided but a sample (in `y` or + `x`) is set, we compute the lower as the last sample + point below 1.5 times the IQR. + lowerfencesrc + Sets the source reference on Chart Studio Cloud for + `lowerfence`. + marker + :class:`plotly.graph_objects.box.Marker` instance or + dict with compatible properties + mean + Sets the mean values. There should be as many items as + the number of boxes desired. This attribute has effect + only under the q1/median/q3 signature. If `mean` is not + provided but a sample (in `y` or `x`) is set, we + compute the mean for each box using the sample values. + meansrc + Sets the source reference on Chart Studio Cloud for + `mean`. + median + Sets the median values. There should be as many items + as the number of boxes desired. + mediansrc + Sets the source reference on Chart Studio Cloud for + `median`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For box traces, the name will + also be used for the position coordinate, if `x` and + `x0` (`y` and `y0` if horizontal) are missing and the + position axis is categorical + notched + Determines whether or not notches are drawn. Notches + displays a confidence interval around the median. We + compute the confidence interval as median +/- 1.57 * + IQR / sqrt(N), where IQR is the interquartile range and + N is the sample size. If two boxes' notches do not + overlap there is 95% confidence their medians differ. + See https://sites.google.com/site/davidsstatistics/home + /notched-box-plots for more info. Defaults to False + unless `notchwidth` or `notchspan` is set. + notchspan + Sets the notch span from the boxes' `median` values. + There should be as many items as the number of boxes + desired. This attribute has effect only under the + q1/median/q3 signature. If `notchspan` is not provided + but a sample (in `y` or `x`) is set, we compute it as + 1.57 * IQR / sqrt(N), where N is the sample size. + notchspansrc + Sets the source reference on Chart Studio Cloud for + `notchspan`. + notchwidth + Sets the width of the notches relative to the box' + width. For example, with 0, the notches are as wide as + the box(es). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the box(es). If "v" ("h"), the + distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the box(es). If 0, the sample points are places over + the center of the box(es). Positive (negative) values + correspond to positions to the right (left) for + vertical boxes and above (below) for horizontal boxes + q1 + Sets the Quartile 1 values. There should be as many + items as the number of boxes desired. + q1src + Sets the source reference on Chart Studio Cloud for + `q1`. + q3 + Sets the Quartile 3 values. There should be as many + items as the number of boxes desired. + q3src + Sets the source reference on Chart Studio Cloud for + `q3`. + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + sd + Sets the standard deviation values. There should be as + many items as the number of boxes desired. This + attribute has effect only under the q1/median/q3 + signature. If `sd` is not provided but a sample (in `y` + or `x`) is set, we compute the standard deviation for + each box using the sample values. + sdmultiple + Scales the box size when sizemode=sd Allowing boxes to + be drawn across any stddev range For example 1-stddev, + 3-stddev, 5-stddev + sdsrc + Sets the source reference on Chart Studio Cloud for + `sd`. + selected + :class:`plotly.graph_objects.box.Selected` instance or + dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showwhiskers + Determines whether or not whiskers are visible. + Defaults to true for `sizemode` "quartiles", false for + "sd". + sizemode + Sets the upper and lower bound for the boxes quartiles + means box is drawn between Q1 and Q3 SD means the box + is drawn between Mean +- Standard Deviation Argument + sdmultiple (default 1) to scale the box size So it + could be drawn 1-stddev, 3-stddev etc + stream + :class:`plotly.graph_objects.box.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.box.Unselected` instance + or dict with compatible properties + upperfence + Sets the upper fence values. There should be as many + items as the number of boxes desired. This attribute + has effect only under the q1/median/q3 signature. If + `upperfence` is not provided but a sample (in `y` or + `x`) is set, we compute the upper as the last sample + point above 1.5 times the IQR. + upperfencesrc + Sets the source reference on Chart Studio Cloud for + `upperfence`. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + width + Sets the width of the box in data coordinate If 0 + (default value) the width is automatically selected + based on the positions of other box traces in the same + subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Box + + new_trace = Box( + alignmentgroup=alignmentgroup, + boxmean=boxmean, + boxpoints=boxpoints, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + jitter=jitter, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + lowerfence=lowerfence, + lowerfencesrc=lowerfencesrc, + marker=marker, + mean=mean, + meansrc=meansrc, + median=median, + mediansrc=mediansrc, + meta=meta, + metasrc=metasrc, + name=name, + notched=notched, + notchspan=notchspan, + notchspansrc=notchspansrc, + notchwidth=notchwidth, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + pointpos=pointpos, + q1=q1, + q1src=q1src, + q3=q3, + q3src=q3src, + quartilemethod=quartilemethod, + sd=sd, + sdmultiple=sdmultiple, + sdsrc=sdsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showwhiskers=showwhiskers, + sizemode=sizemode, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + upperfence=upperfence, + upperfencesrc=upperfencesrc, + visible=visible, + whiskerwidth=whiskerwidth, + width=width, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_candlestick( + self, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + low=None, + lowsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + whiskerwidth=None, + x=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + yaxis=None, + yhoverformat=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Candlestick trace + + The candlestick is a style of financial chart describing open, + high, low and close for a given `x` coordinate (most likely + time). The boxes represent the spread between the `open` and + `close` values and the lines represent the spread between the + `low` and `high` values Sample points where the close value is + higher (lower) then the open value are called increasing + (decreasing). By default, increasing candles are drawn in green + whereas decreasing are drawn in red. + + Parameters + ---------- + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.candlestick.Decreasing` + instance or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.candlestick.Hoverlabel` + instance or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.candlestick.Increasing` + instance or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.candlestick.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.candlestick.Line` instance + or dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.candlestick.Stream` + instance or dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + whiskerwidth + Sets the width of the whiskers relative to the box' + width. For example, with 1, the whiskers are as wide as + the box(es). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Candlestick + + new_trace = Candlestick( + close=close, + closesrc=closesrc, + customdata=customdata, + customdatasrc=customdatasrc, + decreasing=decreasing, + high=high, + highsrc=highsrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + increasing=increasing, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + low=low, + lowsrc=lowsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + open=open, + opensrc=opensrc, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + whiskerwidth=whiskerwidth, + x=x, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + yaxis=yaxis, + yhoverformat=yhoverformat, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_carpet( + self, + a=None, + a0=None, + aaxis=None, + asrc=None, + b=None, + b0=None, + baxis=None, + bsrc=None, + carpet=None, + cheaterslope=None, + color=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + font=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xsrc=None, + y=None, + yaxis=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Carpet trace + + The data describing carpet axis layout is set in `y` and + (optionally) also `x`. If only `y` is present, `x` the plot is + interpreted as a cheater plot and is filled in using the `y` + values. `x` and `y` may either be 2D arrays matching with each + dimension matching that of `a` and `b`, or they may be 1D + arrays with total length equal to that of `a` and `b`. + + Parameters + ---------- + a + An array containing values of the first parameter value + a0 + Alternate to `a`. Builds a linear space of a + coordinates. Use with `da` where `a0` is the starting + coordinate and `da` the step. + aaxis + :class:`plotly.graph_objects.carpet.Aaxis` instance or + dict with compatible properties + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + A two dimensional array of y coordinates at each carpet + point. + b0 + Alternate to `b`. Builds a linear space of a + coordinates. Use with `db` where `b0` is the starting + coordinate and `db` the step. + baxis + :class:`plotly.graph_objects.carpet.Baxis` instance or + dict with compatible properties + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + cheaterslope + The shift applied to each successive row of data in + creating a cheater plot. Only used if `x` is been + omitted. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the a coordinate step. See `a0` for more info. + db + Sets the b coordinate step. See `b0` for more info. + font + The default font used for axis & tick labels on this + carpet + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.carpet.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + stream + :class:`plotly.graph_objects.carpet.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + A two dimensional array of x coordinates at each carpet + point. If omitted, the plot is a cheater plot and the + xaxis is hidden by default. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + A two dimensional array of y coordinates at each carpet + point. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Carpet + + new_trace = Carpet( + a=a, + a0=a0, + aaxis=aaxis, + asrc=asrc, + b=b, + b0=b0, + baxis=baxis, + bsrc=bsrc, + carpet=carpet, + cheaterslope=cheaterslope, + color=color, + customdata=customdata, + customdatasrc=customdatasrc, + da=da, + db=db, + font=font, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + stream=stream, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_choropleth( + self, + 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, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Choropleth trace + + The data that describes the choropleth value-to-color mapping + is set in `z`. The geographic locations corresponding to each + value in `z` are set in `locations`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choropleth.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choropleth.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choropleth.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. See + `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choropleth.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choropleth.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choropleth.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choropleth.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Choropleth + + new_trace = Choropleth( + autocolorscale=autocolorscale, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + geo=geo, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + locationmode=locationmode, + locations=locations, + locationssrc=locationssrc, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + reversescale=reversescale, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_choroplethmap( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + subplot=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, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Choroplethmap trace + + GeoJSON features to be filled are set in `geojson` The data + that describes the choropleth value-to-color mapping is set in + `locations` and `z`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmap traces are placed above the water layers. + If set to '', the layer will be inserted above every + existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmap.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmap.Unselected` + instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Choroplethmap + + new_trace = Choroplethmap( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + locations=locations, + locationssrc=locationssrc, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + reversescale=reversescale, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_choroplethmapbox( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + subplot=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, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Choroplethmapbox trace + + "choroplethmapbox" trace is deprecated! Please consider + switching to the "choroplethmap" trace type and `map` subplots. + Learn more at: https://plotly.com/python/maplibre-migration/ as + well as https://plotly.com/javascript/maplibre-migration/ + GeoJSON features to be filled are set in `geojson` The data + that describes the choropleth value-to-color mapping is set in + `locations` and `z`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the choropleth polygons will be inserted + before the layer with the specified ID. By default, + choroplethmapbox traces are placed above the water + layers. If set to '', the layer will be inserted above + every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.choroplethmapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. + Support nested property, for example "properties.name". + geojson + Sets the GeoJSON data associated with this trace. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.choroplethmapbox.Hoverlabe + l` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `properties` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.choroplethmapbox.Legendgro + uptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + locations + Sets which features found in "geojson" to plot using + their feature `id` field. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + marker + :class:`plotly.graph_objects.choroplethmapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + selected + :class:`plotly.graph_objects.choroplethmapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.choroplethmapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets the text elements associated with each location. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.choroplethmapbox.Unselecte + d` instance or dict with compatible properties + 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). + z + Sets the color values. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Choroplethmapbox + + new_trace = Choroplethmapbox( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + locations=locations, + locationssrc=locationssrc, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + reversescale=reversescale, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_cone( + self, + anchor=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + sizemode=None, + sizeref=None, + stream=None, + text=None, + textsrc=None, + u=None, + uhoverformat=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + vhoverformat=None, + visible=None, + vsrc=None, + w=None, + whoverformat=None, + wsrc=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Cone trace + + Use cone traces to visualize vector fields. Specify a vector + field using 6 1D arrays, 3 position arrays `x`, `y` and `z` and + 3 vector component arrays `u`, `v`, `w`. The cones are drawn + exactly at the positions given by `x`, `y` and `z`. + + Parameters + ---------- + anchor + Sets the cones' anchor with respect to their x/y/z + positions. Note that "cm" denote the cone's center of + mass which corresponds to 1/4 from the tail to tip. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.cone.ColorBar` instance or + dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.cone.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `norm` Anything contained in tag `` + is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.cone.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.cone.Lighting` instance or + dict with compatible properties + lightposition + :class:`plotly.graph_objects.cone.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizemode + Determines whether `sizeref` is set as a "scaled" (i.e + unitless) scalar (normalized by the max u/v/w norm in + the vector field) or as "absolute" value (in the same + units as the vector field). To display sizes in actual + vector length use "raw". + sizeref + Adjusts the cone size scaling. The size of the cones is + determined by their u/v/w norm multiplied a factor and + `sizeref`. This factor (computed internally) + corresponds to the minimum "time" to travel across two + successive x/y/z positions at the average velocity of + those two successive positions. All cones in a given + trace use the same factor. With `sizemode` set to + "raw", its default value is 1. With `sizemode` set to + "scaled", `sizeref` is unitless, its default value is + 0.5. With `sizemode` set to "absolute", `sizeref` has + the same units as the u/v/w vector field, its the + default value is half the sample's maximum vector norm. + stream + :class:`plotly.graph_objects.cone.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the cones. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field and of the + displayed cones. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field and of the + displayed cones. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field and of the + displayed cones. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Cone + + new_trace = Cone( + anchor=anchor, + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + sizemode=sizemode, + sizeref=sizeref, + stream=stream, + text=text, + textsrc=textsrc, + u=u, + uhoverformat=uhoverformat, + uid=uid, + uirevision=uirevision, + usrc=usrc, + v=v, + vhoverformat=vhoverformat, + visible=visible, + vsrc=vsrc, + w=w, + whoverformat=whoverformat, + wsrc=wsrc, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_contour( + self, + autocolorscale=None, + autocontour=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoverongaps=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textfont=None, + textsrc=None, + texttemplate=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Contour trace + + The data from which contour lines are computed is set in `z`. + Data in `z` must be a 2D list of numbers. Say that `z` has N + rows and M columns, then by default, these N rows correspond to + N y coordinates (set in `y` or auto-generated) and the M + columns correspond to M x coordinates (set in `x` or auto- + generated). By setting `transpose` to True, the above behavior + is flipped. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contour.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array otherwise it + is defaulted to false. + contours + :class:`plotly.graph_objects.contour.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.contour.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contour.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contour.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contour.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Contour + + new_trace = Contour( + autocolorscale=autocolorscale, + autocontour=autocontour, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + connectgaps=connectgaps, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoverongaps=hoverongaps, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + ncontours=ncontours, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textfont=textfont, + textsrc=textsrc, + texttemplate=texttemplate, + transpose=transpose, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + xtype=xtype, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + ytype=ytype, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zorder=zorder, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_contourcarpet( + self, + a=None, + a0=None, + asrc=None, + atype=None, + autocolorscale=None, + autocontour=None, + b=None, + b0=None, + bsrc=None, + btype=None, + carpet=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + da=None, + db=None, + fillcolor=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + xaxis=None, + yaxis=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Contourcarpet trace + + Plots contours on either the first carpet axis or the carpet + axis with a matching `carpet` attribute. Data `z` is + interpreted as matching that of the corresponding carpet axis. + + Parameters + ---------- + a + Sets the x coordinates. + a0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + atype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + b + Sets the y coordinates. + b0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + btype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + carpet + The `carpet` of the carpet axes on which this contour + trace lies + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.contourcarpet.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.contourcarpet.Contours` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + da + Sets the x coordinate step. See `x0` for more info. + db + Sets the y coordinate step. See `y0` for more info. + fillcolor + Sets the fill color if `contours.type` is "constraint". + Defaults to a half-transparent variant of the line + color, marker color, or marker line color, whichever is + available. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.contourcarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.contourcarpet.Line` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.contourcarpet.Stream` + instance or dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Contourcarpet + + new_trace = Contourcarpet( + a=a, + a0=a0, + asrc=asrc, + atype=atype, + autocolorscale=autocolorscale, + autocontour=autocontour, + b=b, + b0=b0, + bsrc=bsrc, + btype=btype, + carpet=carpet, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + da=da, + db=db, + fillcolor=fillcolor, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + ncontours=ncontours, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textsrc=textsrc, + transpose=transpose, + uid=uid, + uirevision=uirevision, + visible=visible, + xaxis=xaxis, + yaxis=yaxis, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zorder=zorder, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_densitymap( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lon=None, + lonsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + radius=None, + radiussrc=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Densitymap trace + + Draws a bivariate kernel density estimation with a Gaussian + kernel from `lon` and `lat` coordinates and optional `z` values + using a colorscale. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymap trace will be inserted + before the layer with the specified ID. By default, + densitymap traces are placed below the first layer of + type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymap.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymap + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Densitymap + + new_trace = Densitymap( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lon=lon, + lonsrc=lonsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + radius=radius, + radiussrc=radiussrc, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_densitymapbox( + self, + autocolorscale=None, + below=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lon=None, + lonsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + radius=None, + radiussrc=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + subplot=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + z=None, + zauto=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Densitymapbox trace + + "densitymapbox" trace is deprecated! Please consider switching + to the "densitymap" trace type and `map` subplots. Learn more + at: https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ Draws a + bivariate kernel density estimation with a Gaussian kernel from + `lon` and `lat` coordinates and optional `z` values using a + colorscale. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + below + Determines if the densitymapbox trace will be inserted + before the layer with the specified ID. By default, + densitymapbox traces are placed below the first layer + of type symbol If set to '', the layer will be inserted + above every existing layer. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.densitymapbox.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.densitymapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.densitymapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + radius + Sets the radius of influence of one `lon` / `lat` point + in pixels. Increasing the value makes the densitymapbox + trace smoother, but less detailed. + radiussrc + Sets the source reference on Chart Studio Cloud for + `radius`. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.densitymapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + z + Sets the points' weight. For example, a value of 10 + would be equivalent to having 10 points of weight 1 in + the same spot + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Densitymapbox + + new_trace = Densitymapbox( + autocolorscale=autocolorscale, + below=below, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lon=lon, + lonsrc=lonsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + radius=radius, + radiussrc=radiussrc, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + subplot=subplot, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + z=z, + zauto=zauto, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_funnel( + self, + alignmentgroup=None, + cliponaxis=None, + connector=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Funnel trace + + Visualize stages in a process using length-encoded bars. This + trace can be used to show data in either a part-to-whole + representation wherein each item appears in a single stage, or + in a "drop-off" representation wherein each item appears in + each stage it traversed. See also the "funnelarea" trace type + for a different approach to visualizing funnel data. + + Parameters + ---------- + 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. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious` and + `percentTotal`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnel.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the funnels. With "v" ("h"), + the value of the each bar spans along the vertical + (horizontal). By default funnels are tend to be + oriented horizontally; unless only "y" array is + presented or orientation is set to "v". Also regarding + graphs including only 'horizontal' funnels, "autorange" + on the "y-axis" are set to "reversed". + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple funnels, percentages & + totals are computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious`, + `percentTotal`, `label` and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Funnel + + new_trace = Funnel( + alignmentgroup=alignmentgroup, + cliponaxis=cliponaxis, + connector=connector, + constraintext=constraintext, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + visible=visible, + width=width, + x=x, + x0=x0, + xaxis=xaxis, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_funnelarea( + self, + aspectratio=None, + baseratio=None, + customdata=None, + customdatasrc=None, + dlabel=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + label0=None, + labels=None, + labelssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + scalegroup=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + title=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Funnelarea trace + + Visualize stages in a process using area-encoded trapezoids. + This trace can be used to show data in a part-to-whole + representation similar to a "pie" trace, wherein each item + appears in a single stage. See also the "funnel" trace type for + a different approach to visualizing funnel data. + + Parameters + ---------- + aspectratio + Sets the ratio between height and width + baseratio + Sets the ratio between bottom length and maximum top + length. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnelarea.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + scalegroup + If there are multiple funnelareas that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Funnelarea + + new_trace = Funnelarea( + aspectratio=aspectratio, + baseratio=baseratio, + customdata=customdata, + customdatasrc=customdatasrc, + dlabel=dlabel, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + label0=label0, + labels=labels, + labelssrc=labelssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + scalegroup=scalegroup, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + title=title, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_heatmap( + self, + autocolorscale=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoverongaps=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textfont=None, + textsrc=None, + texttemplate=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xgap=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ygap=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsmooth=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Heatmap trace + + The data that describes the heatmap value-to-color mapping is + set in `z`. Data in `z` can either be a 2D list of values + (ragged or not) or a 1D array of values. In the case where `z` + is a 2D list, say that `z` has N rows and M columns. Then, by + default, the resulting heatmap will have N partitions along the + y axis and M partitions along the x axis. In other words, the + i-th row/ j-th column cell in `z` is mapped to the i-th + partition of the y axis (starting from the bottom of the plot) + and the j-th partition of the x-axis (starting from the left of + the plot). This behavior can be flipped by using `transpose`. + Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) + elements. If M (N), then the coordinates correspond to the + center of the heatmap cells and the cells have equal width. If + M+1 (N+1), then the coordinates correspond to the edges of the + heatmap cells. In the case where `z` is a 1D list, the x and y + coordinates must be provided in `x` and `y` respectively to + form data triplets. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array and `zsmooth` + is not false; otherwise it is defaulted to false. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.heatmap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Heatmap + + new_trace = Heatmap( + autocolorscale=autocolorscale, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoverongaps=hoverongaps, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textfont=textfont, + textsrc=textsrc, + texttemplate=texttemplate, + transpose=transpose, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xgap=xgap, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + xtype=xtype, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + ygap=ygap, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + ytype=ytype, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zorder=zorder, + zsmooth=zsmooth, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_histogram( + self, + alignmentgroup=None, + autobinx=None, + autobiny=None, + bingroup=None, + cliponaxis=None, + constraintext=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, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + offsetgroup=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + xaxis=None, + xbins=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybins=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Histogram trace + + The sample data from which statistics are computed is set in + `x` for vertically spanning histograms and in `y` for + horizontally spanning histograms. Binning options are set + `xbins` and `ybins` respectively if no aggregation data is + provided. + + Parameters + ---------- + 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. + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + 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 `barmode` + "stack", "relative" and "group" are forced into the + same bingroup, Using `bingroup`, traces under `barmode` + "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 `bingroup` + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + cumulative + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `binNumber` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties + 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. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the text font. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label` and `value`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Histogram + + new_trace = Histogram( + alignmentgroup=alignmentgroup, + autobinx=autobinx, + autobiny=autobiny, + bingroup=bingroup, + cliponaxis=cliponaxis, + constraintext=constraintext, + cumulative=cumulative, + customdata=customdata, + customdatasrc=customdatasrc, + error_x=error_x, + error_y=error_y, + histfunc=histfunc, + histnorm=histnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + nbinsx=nbinsx, + nbinsy=nbinsy, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + x=x, + xaxis=xaxis, + xbins=xbins, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ybins=ybins, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_histogram2d( + self, + autobinx=None, + autobiny=None, + autocolorscale=None, + bingroup=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + textfont=None, + texttemplate=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbingroup=None, + xbins=None, + xcalendar=None, + xgap=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybingroup=None, + ybins=None, + ycalendar=None, + ygap=None, + yhoverformat=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsmooth=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Histogram2d trace + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a heatmap. + + Parameters + ---------- + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2d.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties + textfont + Sets the text font. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Histogram2d + + new_trace = Histogram2d( + autobinx=autobinx, + autobiny=autobiny, + autocolorscale=autocolorscale, + bingroup=bingroup, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + histfunc=histfunc, + histnorm=histnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + nbinsx=nbinsx, + nbinsy=nbinsy, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + textfont=textfont, + texttemplate=texttemplate, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xbingroup=xbingroup, + xbins=xbins, + xcalendar=xcalendar, + xgap=xgap, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ybingroup=ybingroup, + ybins=ybins, + ycalendar=ycalendar, + ygap=ygap, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsmooth=zsmooth, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_histogram2dcontour( + self, + autobinx=None, + autobiny=None, + autocolorscale=None, + autocontour=None, + bingroup=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + textfont=None, + texttemplate=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbingroup=None, + xbins=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybingroup=None, + ybins=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Histogram2dContour trace + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a contour plot. + + Parameters + ---------- + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2dcontour.Legendg + rouptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Histogram2dContour + + new_trace = Histogram2dContour( + autobinx=autobinx, + autobiny=autobiny, + autocolorscale=autocolorscale, + autocontour=autocontour, + bingroup=bingroup, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + histfunc=histfunc, + histnorm=histnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + nbinsx=nbinsx, + nbinsy=nbinsy, + ncontours=ncontours, + opacity=opacity, + reversescale=reversescale, + showlegend=showlegend, + showscale=showscale, + stream=stream, + textfont=textfont, + texttemplate=texttemplate, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xbingroup=xbingroup, + xbins=xbins, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yaxis=yaxis, + ybingroup=ybingroup, + ybins=ybins, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zauto=zauto, + zhoverformat=zhoverformat, + zmax=zmax, + zmid=zmid, + zmin=zmin, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_icicle( + self, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + labels=None, + labelssrc=None, + leaf=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + pathbar=None, + root=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + tiling=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Icicle trace + + Visualize hierarchal data from leaves (and/or outer branches) + towards root with rectangles. The icicle sectors are determined + by the entries in "labels" or "ids" and in "parents". + + Parameters + ---------- + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.icicle.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.icicle.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.icicle.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.icicle.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.icicle.Marker` instance or + dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.icicle.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.icicle.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.icicle.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.icicle.Tiling` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Icicle + + new_trace = Icicle( + branchvalues=branchvalues, + count=count, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + labels=labels, + labelssrc=labelssrc, + leaf=leaf, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + level=level, + marker=marker, + maxdepth=maxdepth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + parents=parents, + parentssrc=parentssrc, + pathbar=pathbar, + root=root, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + tiling=tiling, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_image( + self, + colormodel=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + source=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x0=None, + xaxis=None, + y0=None, + yaxis=None, + z=None, + zmax=None, + zmin=None, + zorder=None, + zsmooth=None, + zsrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Image trace + + Display an image, i.e. data on a 2D regular raster. By default, + when an image is displayed in a subplot, its y axis will be + reversed (ie. `autorange: 'reversed'`), constrained to the + domain (ie. `constrain: 'domain'`) and it will have the same + scale as its x axis (ie. `scaleanchor: 'x,`) in order for + pixels to be rendered as squares. + + Parameters + ---------- + colormodel + Color model used to map the numerical color components + described in `z` into colors. If `source` is specified, + this attribute will be set to `rgba256` otherwise it + defaults to `rgb`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Set the pixel's horizontal size. + dy + Set the pixel's vertical size + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `z`, `color` and `colormodel`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.image.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + source + Specifies the data URI of the image to be visualized. + The URI consists of "data:image/[][;base64]," + stream + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x0 + Set the image's x position. The left edge of the image + (or the right edge if the x axis is reversed or dx is + negative) will be found at xmin=x0-dx/2 + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + y0 + Set the image's y position. The top edge of the image + (or the bottom edge if the y axis is NOT reversed or if + dy is negative) will be found at ymin=y0-dy/2. By + default when an image trace is included, the y axis + will be reversed so that the image is right-side-up, + but you can disable this by setting + yaxis.autorange=true or by providing an explicit y axis + range. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + A 2-dimensional array in which each element is an array + of 3 or 4 numbers representing a color. + zmax + Array defining the higher bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [255, + 255, 255]. For the `rgba` colormodel, it is [255, 255, + 255, 1]. For the `rgba256` colormodel, it is [255, 255, + 255, 255]. For the `hsl` colormodel, it is [360, 100, + 100]. For the `hsla` colormodel, it is [360, 100, 100, + 1]. + zmin + Array defining the lower bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [0, 0, + 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For + the `rgba256` colormodel, it is [0, 0, 0, 0]. For the + `hsl` colormodel, it is [0, 0, 0]. For the `hsla` + colormodel, it is [0, 0, 0, 0]. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm used to smooth `z` data. + This only applies for image traces that use the + `source` attribute. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Image + + new_trace = Image( + colormodel=colormodel, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + source=source, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + x0=x0, + xaxis=xaxis, + y0=y0, + yaxis=yaxis, + z=z, + zmax=zmax, + zmin=zmin, + zorder=zorder, + zsmooth=zsmooth, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_indicator( + self, + align=None, + customdata=None, + customdatasrc=None, + delta=None, + domain=None, + gauge=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + mode=None, + name=None, + number=None, + stream=None, + title=None, + uid=None, + uirevision=None, + value=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Indicator trace + + An indicator is used to visualize a single `value` along with + some contextual information such as `steps` or a `threshold`, + using a combination of three visual elements: a number, a + delta, and/or a gauge. Deltas are taken with respect to a + `reference`. Gauges can be either angular or bullet (aka + linear) gauges. + + Parameters + ---------- + align + Sets the horizontal alignment of the `text` within the + box. Note that this attribute has no effect if an + angular gauge is displayed: in this case, it is always + centered + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delta + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties + domain + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties + gauge + The gauge of the Indicator plot. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.indicator.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines how the value is displayed on the graph. + `number` displays the value numerically in text. + `delta` displays the difference to a reference value in + text. Finally, `gauge` displays the value graphically + on an axis. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + number + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties + stream + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties + title + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the number to be displayed. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Indicator + + new_trace = Indicator( + align=align, + customdata=customdata, + customdatasrc=customdatasrc, + delta=delta, + domain=domain, + gauge=gauge, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + number=number, + stream=stream, + title=title, + uid=uid, + uirevision=uirevision, + value=value, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_isosurface( + self, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuehoverformat=None, + valuesrc=None, + visible=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Isosurface trace + + Draws isosurfaces between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.isosurface.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties + spaceframe + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties + surface + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Isosurface + + new_trace = Isosurface( + autocolorscale=autocolorscale, + caps=caps, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contour=contour, + customdata=customdata, + customdatasrc=customdatasrc, + flatshading=flatshading, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + isomax=isomax, + isomin=isomin, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + slices=slices, + spaceframe=spaceframe, + stream=stream, + surface=surface, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + value=value, + valuehoverformat=valuehoverformat, + valuesrc=valuesrc, + visible=visible, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_mesh3d( + self, + alphahull=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + delaunayaxis=None, + facecolor=None, + facecolorsrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + i=None, + ids=None, + idssrc=None, + intensity=None, + intensitymode=None, + intensitysrc=None, + isrc=None, + j=None, + jsrc=None, + k=None, + ksrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + vertexcolor=None, + vertexcolorsrc=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Mesh3d trace + + Draws sets of triangles with coordinates given by three + 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, + `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha- + shape algorithm or (4) the Convex-hull algorithm + + Parameters + ---------- + alphahull + Determines how the mesh surface triangles are derived + from the set of vertices (points) represented by the + `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays + are not supplied. For general use of `mesh3d` it is + preferred that `i`, `j`, `k` are supplied. If "-1", + Delaunay triangulation is used, which is mainly + suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In + case the `delaunayaxis` intersects the mesh surface at + more than one point it will result triangles that are + very long in the dimension of `delaunayaxis`. If ">0", + the alpha-shape algorithm is used. In this case, the + positive `alphahull` value signals the use of the + alpha-shape algorithm, _and_ its value acts as the + parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or + if the intention is to enclose the `x`, `y` and `z` + point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `intensity`) or + the bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `intensity` and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `intensity`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `intensity` and if set, `cmax` + must be set as well. + color + Sets the color of the whole mesh + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delaunayaxis + Sets the Delaunay axis, which is the axis that is + perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, `k` are + not provided and `alphahull` is set to indicate + Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" and + "vertexcolor". + facecolorsrc + Sets the source reference on Chart Studio Cloud for + `facecolor`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + i + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "first" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `i[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in space, which + is the first vertex of a triangle. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + intensity + Sets the intensity values for vertices or cells as + defined by `intensitymode`. It can be used for plotting + fields on meshes. + intensitymode + Determines the source of `intensity` values. + intensitysrc + Sets the source reference on Chart Studio Cloud for + `intensity`. + isrc + Sets the source reference on Chart Studio Cloud for + `i`. + j + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "second" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `j[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in space, which + is the second vertex of a triangle. + jsrc + Sets the source reference on Chart Studio Cloud for + `j`. + k + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "third" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `k[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in space, which + is the third vertex of a triangle. + ksrc + Sets the source reference on Chart Studio Cloud for + `k`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.mesh3d.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides "color". While + Red, green and blue colors are in the range of 0 and + 255; in the case of having vertex color data in RGBA + format, the alpha color should be normalized to be + between 0 and 1. + vertexcolorsrc + Sets the source reference on Chart Studio Cloud for + `vertexcolor`. + 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). + x + Sets the X coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Mesh3d + + new_trace = Mesh3d( + alphahull=alphahull, + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + color=color, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contour=contour, + customdata=customdata, + customdatasrc=customdatasrc, + delaunayaxis=delaunayaxis, + facecolor=facecolor, + facecolorsrc=facecolorsrc, + flatshading=flatshading, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + i=i, + ids=ids, + idssrc=idssrc, + intensity=intensity, + intensitymode=intensitymode, + intensitysrc=intensitysrc, + isrc=isrc, + j=j, + jsrc=jsrc, + k=k, + ksrc=ksrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + vertexcolor=vertexcolor, + vertexcolorsrc=vertexcolorsrc, + visible=visible, + x=x, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zcalendar=zcalendar, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_ohlc( + self, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + low=None, + lowsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + tickwidth=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + yaxis=None, + yhoverformat=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Ohlc trace + + The ohlc (short for Open-High-Low-Close) is a style of + financial chart describing open, high, low and close for a + given `x` coordinate (most likely time). The tip of the lines + represent the `low` and `high` values and the horizontal + segments represent the `open` and `close` values. Sample points + where the close value is higher (lower) then the open value are + called increasing (decreasing). By default, increasing items + are drawn in green whereas decreasing are drawn in red. + + Parameters + ---------- + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.ohlc.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + tickwidth + Sets the width of the open/close tick marks relative to + the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Ohlc + + new_trace = Ohlc( + close=close, + closesrc=closesrc, + customdata=customdata, + customdatasrc=customdatasrc, + decreasing=decreasing, + high=high, + highsrc=highsrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + increasing=increasing, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + low=low, + lowsrc=lowsrc, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + open=open, + opensrc=opensrc, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textsrc=textsrc, + tickwidth=tickwidth, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + yaxis=yaxis, + yhoverformat=yhoverformat, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_parcats( + self, + arrangement=None, + bundlecolors=None, + counts=None, + countssrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + hoverinfo=None, + hoveron=None, + hovertemplate=None, + labelfont=None, + legendgrouptitle=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + sortpaths=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Parcats trace + + Parallel categories diagram for multidimensional categorical + data. + + Parameters + ---------- + arrangement + Sets the drag interaction mode for categories and + dimensions. If `perpendicular`, the categories can only + move along a line perpendicular to the paths. If + `freeform`, the categories can freely move on the + plane. If `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled together + within each category. + counts + The number of observations represented by each state. + Defaults to 1 so that each state represents one + observation + countssrc + Sets the source reference on Chart Studio Cloud for + `counts`. + dimensions + The dimensions (variables) of the parallel categories + diagram. + dimensiondefaults + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets + the default property values to use for elements of + parcats.dimensions + domain + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take place + per category. If `color`, hover interactions take place + per color per category. If `dimension`, hover + interactions take place across all categories per + dimension. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. This value here applies when hovering + over dimensions. Note that `*categorycount`, + "colorcount" and "bandcolorcount" are only available + when `hoveron` contains the "color" flagFinally, the + template string has access to variables `count`, + `probability`, `category`, `categorycount`, + `colorcount` and `bandcolorcount`. Anything contained + in tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + labelfont + Sets the font for the `dimension` labels. + legendgrouptitle + :class:`plotly.graph_objects.parcats.Legendgrouptitle` + instance or dict with compatible properties + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, sort + paths based on dimension categories from left to right. + If `backward`, sort paths based on dimensions + categories from right to left. + stream + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Parcats + + new_trace = Parcats( + arrangement=arrangement, + bundlecolors=bundlecolors, + counts=counts, + countssrc=countssrc, + dimensions=dimensions, + dimensiondefaults=dimensiondefaults, + domain=domain, + hoverinfo=hoverinfo, + hoveron=hoveron, + hovertemplate=hovertemplate, + labelfont=labelfont, + legendgrouptitle=legendgrouptitle, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + sortpaths=sortpaths, + stream=stream, + tickfont=tickfont, + uid=uid, + uirevision=uirevision, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_parcoords( + self, + customdata=None, + customdatasrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + ids=None, + idssrc=None, + labelangle=None, + labelfont=None, + labelside=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + rangefont=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Parcoords trace + + Parallel coordinates for multidimensional exploratory data + analysis. The samples are specified in `dimensions`. The colors + are set in `line.color`. + + Parameters + ---------- + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dimensions + The dimensions (variables) of the parallel coordinates + chart. 2..60 dimensions are supported. + dimensiondefaults + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets + the default property values to use for elements of + parcoords.dimensions + domain + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + labelangle + Sets the angle of the labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + labels vertically. Tilted labels with "labelangle" may + be positioned better inside margins when + `labelposition` is set to "bottom". + labelfont + Sets the font for the `dimension` labels. + labelside + Specifies the location of the `label`. "top" positions + labels above, next to the title "bottom" positions + labels below the graph Tilted labels with "labelangle" + may be positioned better inside margins when + `labelposition` is set to "bottom". + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.parcoords.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + rangefont + Sets the font for the `dimension` range values. + stream + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.parcoords.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Parcoords + + new_trace = Parcoords( + customdata=customdata, + customdatasrc=customdatasrc, + dimensions=dimensions, + dimensiondefaults=dimensiondefaults, + domain=domain, + ids=ids, + idssrc=idssrc, + labelangle=labelangle, + labelfont=labelfont, + labelside=labelside, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + meta=meta, + metasrc=metasrc, + name=name, + rangefont=rangefont, + stream=stream, + tickfont=tickfont, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_pie( + self, + automargin=None, + customdata=None, + customdatasrc=None, + direction=None, + dlabel=None, + domain=None, + hole=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + insidetextorientation=None, + label0=None, + labels=None, + labelssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + pull=None, + pullsrc=None, + rotation=None, + scalegroup=None, + showlegend=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + title=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Pie trace + + A data visualized by the sectors of the pie is set in `values`. + The sector labels are set in `labels`. The sector colors are + set in `marker.colors` + + Parameters + ---------- + automargin + Determines whether outside text labels can push the + margins. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + direction + Specifies the direction at which succeeding sectors + follow one another. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties + hole + Sets the fraction of the radius to cut out of the pie. + Use this to make a donut chart. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.pie.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. + pull + Sets the fraction of larger radius to pull the sectors + out from the center. This can be a constant to pull all + slices apart from each other equally or an array to + highlight one or more slices. + pullsrc + Sets the source reference on Chart Studio Cloud for + `pull`. + rotation + Instead of the first slice starting at 12 o'clock, + rotate to some other angle. + scalegroup + If there are multiple pie charts that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Pie + + new_trace = Pie( + automargin=automargin, + customdata=customdata, + customdatasrc=customdatasrc, + direction=direction, + dlabel=dlabel, + domain=domain, + hole=hole, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + insidetextorientation=insidetextorientation, + label0=label0, + labels=labels, + labelssrc=labelssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + pull=pull, + pullsrc=pullsrc, + rotation=rotation, + scalegroup=scalegroup, + showlegend=showlegend, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + title=title, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_sankey( + self, + arrangement=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverlabel=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Sankey trace + + Sankey plots for network flow data analysis. The nodes are + specified in `nodes` and the links between sources and targets + in `links`. The colors are set in `nodes[i].color` and + `links[i].color`, otherwise defaults are used. + + Parameters + ---------- + arrangement + If value is `snap` (the default), the node arrangement + is assisted by automatic snapping of elements to + preserve space between nodes specified via `nodepad`. + If value is `perpendicular`, the nodes can only move + along a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the plane. If + value is `fixed`, the nodes are stationary. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. Note that this attribute is + superseded by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sankey.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + link + The links of the Sankey plot. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + node + The nodes of the Sankey plot. + orientation + Sets the orientation of the Sankey diagram. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + stream + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + valuesuffix + Adds a unit to follow the value in the hover tooltip. + Add a space if a separation is necessary from the + value. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Sankey + + new_trace = Sankey( + arrangement=arrangement, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverlabel=hoverlabel, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + link=link, + meta=meta, + metasrc=metasrc, + name=name, + node=node, + orientation=orientation, + selectedpoints=selectedpoints, + stream=stream, + textfont=textfont, + uid=uid, + uirevision=uirevision, + valueformat=valueformat, + valuesuffix=valuesuffix, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatter( + self, + alignmentgroup=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + fillgradient=None, + fillpattern=None, + groupnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + selected=None, + selectedpoints=None, + showlegend=None, + stackgaps=None, + stackgroup=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scatter trace + + The scatter trace type encompasses line charts, scatter charts, + text charts, and bubble charts. The data visualized as scatter + point or lines is set in `x` and `y`. Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + 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. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. If fillgradient is + specified, fillcolor is ignored except for setting the + background color of the hover label, if any. + fillgradient + Sets a fill gradient. If not specified, the fillcolor + is used instead. + fillpattern + Sets the pattern within the marker. + groupnorm + Only relevant when `stackgroup` is used, and only the + first `groupnorm` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value of each + trace at each location is divided by the sum of all + trace values at that location. "percent" is the same + but multiplied by 100 to show percentages. If there are + multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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. + opacity + Sets the opacity of the trace. + orientation + Only relevant in the following cases: 1. when + `scattermode` is set to "group". 2. when `stackgroup` + is used, and only the first `orientation` found in the + `stackgroup` will be used - including if `visible` is + "legendonly" but not if it is `false`. Sets the + stacking direction. With "v" ("h"), the y (x) values of + subsequent traces are added. Also affects the default + value of `fill`. + selected + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and only the + first `stackgaps` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Determines how we handle locations at + which other traces in this group have data but this one + does not. With *infer zero* we insert a zero at these + locations. With "interpolate" we linearly interpolate + between existing values, and extrapolate a constant + beyond the existing values. + stackgroup + Set several scatter traces (on the same subplot) to the + same stackgroup in order to add their y values (or + their x values if `orientation` is "h"). If blank or + omitted this trace will not be stacked. Stacking also + turns `fill` on by default, using "tonexty" ("tonextx") + if `orientation` is "h" ("v") and sets the default + `mode` to "lines" irrespective of point count. You can + only stack on a numeric (linear or log) axis. Traces in + a `stackgroup` will only fill to (or be filled to) + other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if + fill-linked traces are not already consecutive, the + later ones will be pushed down in the drawing order. + stream + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scatter + + new_trace = Scatter( + alignmentgroup=alignmentgroup, + cliponaxis=cliponaxis, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + error_x=error_x, + error_y=error_y, + fill=fill, + fillcolor=fillcolor, + fillgradient=fillgradient, + fillpattern=fillpattern, + groupnorm=groupnorm, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stackgaps=stackgaps, + stackgroup=stackgroup, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_scatter3d( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + error_x=None, + error_y=None, + error_z=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + projection=None, + scene=None, + showlegend=None, + stream=None, + surfaceaxis=None, + surfacecolor=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scatter3d trace + + The data visualized as scatter point or lines in 3D dimension + is set in `x`, `y`, `z`. Text (appearing either on the chart or + on hover only) is via `text`. Bubble charts are achieved by + setting `marker.size` and/or `marker.color` Projections are + achieved via `projection`. Surface fills are achieved via + `surfaceaxis`. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties + error_z + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter3d.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + projection + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a surface + If 0, 1, 2, the scatter points are filled with a + Delaunay surface about the x, y, z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scatter3d + + new_trace = Scatter3d( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + error_x=error_x, + error_y=error_y, + error_z=error_z, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + projection=projection, + scene=scene, + showlegend=showlegend, + stream=stream, + surfaceaxis=surfaceaxis, + surfacecolor=surfacecolor, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zcalendar=zcalendar, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattercarpet( + self, + a=None, + asrc=None, + b=None, + bsrc=None, + carpet=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxis=None, + yaxis=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scattercarpet trace + + Plots a scatter trace on either the first carpet axis or the + carpet axis with a matching `carpet` attribute. + + Parameters + ---------- + a + Sets the a-axis coordinates. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b). To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattercarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (a,b) point. If + a single string, the same string appears over all the + data points. If an array of strings, the items are + mapped in order to the the data points in (a,b). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scattercarpet + + new_trace = Scattercarpet( + a=a, + asrc=asrc, + b=b, + bsrc=bsrc, + carpet=carpet, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + xaxis=xaxis, + yaxis=yaxis, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_scattergeo( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + fill=None, + fillcolor=None, + geo=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + locationmode=None, + locations=None, + locationssrc=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scattergeo trace + + The data visualized as scatter point or lines on a geographic + map is provided either by longitude/latitude pairs in `lon` and + `lat` respectively or by geographic location IDs or names in + `locations`. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + geojson + Sets optional GeoJSON data associated with this trace. + If not given, the features on the base map are used + when `locations` is set. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair or item in `locations`. If a single string, the + same string appears over all the data points. If an + array of string, the items are mapped in order to the + this trace's (lon,lat) or `locations` coordinates. To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergeo.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each location + given. See `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (lon,lat) pair + or item in `locations`. If a single string, the same + string appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and "hovertext" is + not set, these elements will be seen in the hover + labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon`, `location` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scattergeo + + new_trace = Scattergeo( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + featureidkey=featureidkey, + fill=fill, + fillcolor=fillcolor, + geo=geo, + geojson=geojson, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + locationmode=locationmode, + locations=locations, + locationssrc=locationssrc, + lon=lon, + lonsrc=lonsrc, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattergl( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scattergl trace + + The data visualized as scatter point or lines is set in `x` and + `y` using the WebGL plotting engine. Bubble charts are achieved + by setting `marker.size` and/or `marker.color` to a numerical + arrays. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergl.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scattergl + + new_trace = Scattergl( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dx=dx, + dy=dy, + error_x=error_x, + error_y=error_y, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + x=x, + x0=x0, + xaxis=xaxis, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_scattermap( + self, + below=None, + cluster=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scattermap trace + + The data visualized as scatter point, lines or marker symbols + on a MapLibre GL geographic map is provided by + longitude/latitude pairs in `lon` and `lat`. + + Parameters + ---------- + below + Determines if this scattermap trace's layers are to be + inserted before the layer with the specified ID. By + default, scattermap layers are inserted above all the + base layers. To place the scattermap layers above every + other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermap.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermap.Line` instance + or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=map.layer.paint.text- + color, size=map.layer.layout.text-size). Has an effect + only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermap.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scattermap + + new_trace = Scattermap( + below=below, + cluster=cluster, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + lon=lon, + lonsrc=lonsrc, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattermapbox( + self, + below=None, + cluster=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scattermapbox trace + + "scattermapbox" trace is deprecated! Please consider switching + to the "scattermap" trace type and `map` subplots. Learn more + at: https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ The data + visualized as scatter point, lines or marker symbols on a + Mapbox GL geographic map is provided by longitude/latitude + pairs in `lon` and `lat`. + + Parameters + ---------- + below + Determines if this scattermapbox trace's layers are to + be inserted before the layer with the specified ID. By + default, scattermapbox layers are inserted above all + the base layers. To place the scattermapbox layers + above every other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermapbox.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scattermapbox + + new_trace = Scattermapbox( + below=below, + cluster=cluster, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + lat=lat, + latsrc=latsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + lon=lon, + lonsrc=lonsrc, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatterpolar( + self, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scatterpolar trace + + The scatterpolar trace type encompasses line charts, scatter + charts, text charts, and bubble charts in polar coordinates. + The data visualized as scatter point or lines is set in `r` + (radial) and `theta` (angular) coordinates Text (appearing + either on the chart or on hover only) is via `text`. Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterpolar has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolar.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scatterpolar + + new_trace = Scatterpolar( + cliponaxis=cliponaxis, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dr=dr, + dtheta=dtheta, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + r=r, + r0=r0, + rsrc=rsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + theta=theta, + theta0=theta0, + thetasrc=thetasrc, + thetaunit=thetaunit, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatterpolargl( + self, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scatterpolargl trace + + The scatterpolargl trace type encompasses line charts, scatter + charts, and bubble charts in polar coordinates using the WebGL + plotting engine. The data visualized as scatter point or lines + is set in `r` (radial) and `theta` (angular) coordinates Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolargl.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scatterpolargl + + new_trace = Scatterpolargl( + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + dr=dr, + dtheta=dtheta, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + r=r, + r0=r0, + rsrc=rsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + theta=theta, + theta0=theta0, + thetasrc=thetasrc, + thetaunit=thetaunit, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scattersmith( + self, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + imag=None, + imagsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + real=None, + realsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scattersmith trace + + The scattersmith trace type encompasses line charts, scatter + charts, text charts, and bubble charts in smith coordinates. + The data visualized as scatter point or lines is set in `real` + and `imag` (imaginary) coordinates Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scattersmith has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattersmith.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + imag + Sets the imaginary component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + imagsrc + Sets the source reference on Chart Studio Cloud for + `imag`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattersmith.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattersmith.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattersmith.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + real + Sets the real component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + realsrc + Sets the source reference on Chart Studio Cloud for + `real`. + selected + :class:`plotly.graph_objects.scattersmith.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattersmith.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a smith subplot. If "smith" (the default value), + the data refer to `layout.smith`. If "smith2", the data + refer to `layout.smith2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `real`, `imag` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattersmith.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scattersmith + + new_trace = Scattersmith( + cliponaxis=cliponaxis, + connectgaps=connectgaps, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + imag=imag, + imagsrc=imagsrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + real=real, + realsrc=realsrc, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_scatterternary( + self, + a=None, + asrc=None, + b=None, + bsrc=None, + c=None, + cliponaxis=None, + connectgaps=None, + csrc=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + sum=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Scatterternary trace + + Provides similar functionality to the "scatter" type but on a + ternary phase diagram. The data is provided by at least two + arrays out of `a`, `b`, `c` triplets. + + Parameters + ---------- + a + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + c + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + csrc + Sets the source reference on Chart Studio Cloud for + `c`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b,c) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b,c). + To be seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterternary.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a ternary subplot. If "ternary" (the default + value), the data refer to `layout.ternary`. If + "ternary2", the data refer to `layout.ternary2`, and so + on. + sum + The number each triplet should sum to, if only two of + `a`, `b`, and `c` are provided. This overrides + `ternary.sum` to normalize this specific trace, but + does not affect the values displayed on the axes. 0 (or + missing) means to use ternary.sum + text + Sets text elements associated with each (a,b,c) point. + If a single string, the same string appears over all + the data points. If an array of strings, the items are + mapped in order to the the data points in (a,b,c). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b`, `c` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Scatterternary + + new_trace = Scatterternary( + a=a, + asrc=asrc, + b=b, + bsrc=bsrc, + c=c, + cliponaxis=cliponaxis, + connectgaps=connectgaps, + csrc=csrc, + customdata=customdata, + customdatasrc=customdatasrc, + fill=fill, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meta=meta, + metasrc=metasrc, + mode=mode, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + subplot=subplot, + sum=sum, + text=text, + textfont=textfont, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_splom( + self, + customdata=None, + customdatasrc=None, + diagonal=None, + dimensions=None, + dimensiondefaults=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + showlowerhalf=None, + showupperhalf=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxes=None, + xhoverformat=None, + yaxes=None, + yhoverformat=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Splom trace + + Splom traces generate scatter plot matrix visualizations. Each + splom `dimensions` items correspond to a generated axis. Values + for each of those dimensions are set in `dimensions[i].values`. + Splom traces support all `scattergl` marker style attributes. + Specify `layout.grid` attributes and/or layout x-axis and + y-axis attributes for more control over the axis positioning + and style. + + Parameters + ---------- + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + diagonal + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties + dimensions + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the + default property values to use for elements of + splom.dimensions + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.splom.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower half + from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper half + from the diagonal are displayed. + stream + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair to + appear on hover. If a single string, the same string + appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties + 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). + xaxes + Sets the list of x axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N xaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + yaxes + Sets the list of y axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N yaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Splom + + new_trace = Splom( + customdata=customdata, + customdatasrc=customdatasrc, + diagonal=diagonal, + dimensions=dimensions, + dimensiondefaults=dimensiondefaults, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + marker=marker, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + showlowerhalf=showlowerhalf, + showupperhalf=showupperhalf, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + xaxes=xaxes, + xhoverformat=xhoverformat, + yaxes=yaxes, + yhoverformat=yhoverformat, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_streamtube( + self, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + maxdisplayed=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + sizeref=None, + starts=None, + stream=None, + text=None, + u=None, + uhoverformat=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + vhoverformat=None, + visible=None, + vsrc=None, + w=None, + whoverformat=None, + wsrc=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Streamtube trace + + Use a streamtube trace to visualize flow in a vector field. + Specify a vector field using 6 1D arrays of equal length, 3 + position arrays `x`, `y` and `z` and 3 vector component arrays + `u`, `v`, and `w`. By default, the tubes' starting positions + will be cut from the vector field's x-z plane at its minimum y + value. To specify your own starting position, use attributes + `starts.x`, `starts.y` and `starts.z`. The color is encoded by + the norm of (u, v, w), and the local radius by the divergence + of (u, v, w). + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `tubex`, `tubey`, `tubez`, `tubeu`, + `tubev`, `tubew`, `norm` and `divergence`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.streamtube.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizeref + The scaling factor for the streamtubes. The default is + 1, which avoids two max divergence tubes from touching + at adjacent starting positions. + starts + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties + text + Sets a text element associated with this trace. If + trace `hoverinfo` contains a "text" flag, this text + element will be seen in all hover labels. Note that + streamtube traces do not support array `text` values. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Streamtube + + new_trace = Streamtube( + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + customdata=customdata, + customdatasrc=customdatasrc, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + maxdisplayed=maxdisplayed, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + sizeref=sizeref, + starts=starts, + stream=stream, + text=text, + u=u, + uhoverformat=uhoverformat, + uid=uid, + uirevision=uirevision, + usrc=usrc, + v=v, + vhoverformat=vhoverformat, + visible=visible, + vsrc=vsrc, + w=w, + whoverformat=whoverformat, + wsrc=wsrc, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_sunburst( + self, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + insidetextorientation=None, + labels=None, + labelssrc=None, + leaf=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + root=None, + rotation=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Sunburst trace + + Visualize hierarchal data spanning outward radially from root + to leaves. The sunburst sectors are determined by the entries + in "labels" or "ids" and in "parents". + + Parameters + ---------- + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sunburst.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented at the center of a sunburst graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + root + :class:`plotly.graph_objects.sunburst.Root` instance or + dict with compatible properties + rotation + Rotates the whole diagram counterclockwise by some + angle. By default the first slice starts at 3 o'clock. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Sunburst + + new_trace = Sunburst( + branchvalues=branchvalues, + count=count, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + insidetextorientation=insidetextorientation, + labels=labels, + labelssrc=labelssrc, + leaf=leaf, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + level=level, + marker=marker, + maxdepth=maxdepth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + parents=parents, + parentssrc=parentssrc, + root=root, + rotation=rotation, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_surface( + self, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + hidesurface=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + opacityscale=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + stream=None, + surfacecolor=None, + surfacecolorsrc=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Surface trace + + The data the describes the coordinates of the surface is set in + `z`. Data in `z` should be a 2D list. Coordinates in `x` and + `y` can either be 1D lists or 2D lists (e.g. to graph + parametric surfaces). If not provided in `x` and `y`, the x and + y coordinates are assumed to be linear starting at 0 with a + unit step. The color scale corresponds to the `z` values by + default. For custom color scales, use `surfacecolor` which + should be a 2D list, where its bounds can be controlled using + `cmin` and `cmax`. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here z or surfacecolor) + or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as z or surfacecolor. + Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + contours + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hidesurface + Determines whether or not a surface is drawn. For + example, set `hidesurface` to False `contours.x.show` + to True and `contours.y.show` to True to draw a wire + frame plot. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.surface.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties + surfacecolor + Sets the surface color values, used for setting a color + scale independent of `z`. + surfacecolorsrc + Sets the source reference on Chart Studio Cloud for + `surfacecolor`. + text + Sets the text elements associated with each z value. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Surface + + new_trace = Surface( + autocolorscale=autocolorscale, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + connectgaps=connectgaps, + contours=contours, + customdata=customdata, + customdatasrc=customdatasrc, + hidesurface=hidesurface, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + opacityscale=opacityscale, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + stream=stream, + surfacecolor=surfacecolor, + surfacecolorsrc=surfacecolorsrc, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + visible=visible, + x=x, + xcalendar=xcalendar, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + ycalendar=ycalendar, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zcalendar=zcalendar, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_table( + self, + cells=None, + columnorder=None, + columnordersrc=None, + columnwidth=None, + columnwidthsrc=None, + customdata=None, + customdatasrc=None, + domain=None, + header=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Table trace + + Table view for detailed data viewing. The data are arranged in + a grid of rows and columns. Most styling can be specified for + columns, rows or individual cells. Table is using a column- + major order, ie. the grid is represented as a vector of column + vectors. + + Parameters + ---------- + cells + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties + columnorder + Specifies the rendered order of the data columns; for + example, a value `2` at position `0` means that column + index `0` in the data will be rendered as the third + column, as columns have an index base of zero. + columnordersrc + Sets the source reference on Chart Studio Cloud for + `columnorder`. + columnwidth + The width of columns expressed as a ratio. Columns fill + the available width in proportion of their specified + column widths. + columnwidthsrc + Sets the source reference on Chart Studio Cloud for + `columnwidth`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties + header + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.table.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + stream + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Table + + new_trace = Table( + cells=cells, + columnorder=columnorder, + columnordersrc=columnordersrc, + columnwidth=columnwidth, + columnwidthsrc=columnwidthsrc, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + header=header, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + ids=ids, + idssrc=idssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + meta=meta, + metasrc=metasrc, + name=name, + stream=stream, + uid=uid, + uirevision=uirevision, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_treemap( + self, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + labels=None, + labelssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + pathbar=None, + root=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + tiling=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Treemap trace + + Visualize hierarchal data from leaves (and/or outer branches) + towards root with rectangles. The treemap sectors are + determined by the entries in "labels" or "ids" and in + "parents". + + Parameters + ---------- + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.treemap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.treemap.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Treemap + + new_trace = Treemap( + branchvalues=branchvalues, + count=count, + customdata=customdata, + customdatasrc=customdatasrc, + domain=domain, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + insidetextfont=insidetextfont, + labels=labels, + labelssrc=labelssrc, + legend=legend, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + level=level, + marker=marker, + maxdepth=maxdepth, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + outsidetextfont=outsidetextfont, + parents=parents, + parentssrc=parentssrc, + pathbar=pathbar, + root=root, + sort=sort, + stream=stream, + text=text, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + tiling=tiling, + uid=uid, + uirevision=uirevision, + values=values, + valuessrc=valuessrc, + visible=visible, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_violin( + self, + alignmentgroup=None, + bandwidth=None, + box=None, + customdata=None, + customdatasrc=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meanline=None, + meta=None, + metasrc=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + points=None, + quartilemethod=None, + scalegroup=None, + scalemode=None, + selected=None, + selectedpoints=None, + showlegend=None, + side=None, + span=None, + spanmode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Violin trace + + In vertical (horizontal) violin plots, statistics are computed + using `y` (`x`) values. By supplying an `x` (`y`) array, one + violin per distinct x (y) value is drawn If no `x` (`y`) list + is provided, a single violin is drawn. That violin position is + then positioned with with `name` or with `x0` (`y0`) if + provided. + + Parameters + ---------- + 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. + bandwidth + Sets the bandwidth used to compute the kernel density + estimate. By default, the bandwidth is determined by + Silverman's rule of thumb. + box + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual violins or + sample points or the kernel density estimate or any + combination of them? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the violins. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.violin.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties + meanline + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For violin traces, the name + will also be used for the position coordinate, if `x` + and `x0` (`y` and `y0` if horizontal) are missing and + the position axis is categorical. Note that the trace + name is also used as a default value for attribute + `scalegroup` (please see its description for details). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" ("h"), + the distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the violins. If 0, the sample points are places over + the center of the violins. Positive (negative) values + correspond to positions to the right (left) for + vertical violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the violins are shown with no sample + points. Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set, otherwise defaults to "outliers". + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + scalegroup + If there are multiple violins that should be sized + according to to some metric (see `scalemode`), link + them by providing a non-empty group id here shared by + every trace in the same group. If a violin's `width` is + undefined, `scalegroup` will default to the trace's + name. In this case, violins with the same names will be + linked together + scalemode + Sets the metric by which the width of each violin is + determined. "width" means each violin has the same + (max) width "count" means the violins are scaled by the + number of sample points making up each violin. + selected + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + side + Determines on which side of the position value the + density function making up one half of a violin is + plotted. Useful when comparing two violin traces under + "overlay" mode, where one trace has `side` set to + "positive" and the other to "negative". + span + Sets the span in data space for which the density + function will be computed. Has an effect only when + `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space where + the density function will be computed. "soft" means the + span goes from the sample's minimum value minus two + bandwidths to the sample's maximum value plus two + bandwidths. "hard" means the span goes from the + sample's minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the `span` + attribute. + stream + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties + 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). + width + Sets the width of the violin in data coordinates. If 0 + (default value) the width is automatically selected + based on the positions of other violin traces in the + same subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Violin + + new_trace = Violin( + alignmentgroup=alignmentgroup, + bandwidth=bandwidth, + box=box, + customdata=customdata, + customdatasrc=customdatasrc, + fillcolor=fillcolor, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hoveron=hoveron, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + jitter=jitter, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + marker=marker, + meanline=meanline, + meta=meta, + metasrc=metasrc, + name=name, + offsetgroup=offsetgroup, + opacity=opacity, + orientation=orientation, + pointpos=pointpos, + points=points, + quartilemethod=quartilemethod, + scalegroup=scalegroup, + scalemode=scalemode, + selected=selected, + selectedpoints=selectedpoints, + showlegend=showlegend, + side=side, + span=span, + spanmode=spanmode, + stream=stream, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + unselected=unselected, + visible=visible, + width=width, + x=x, + x0=x0, + xaxis=xaxis, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + yhoverformat=yhoverformat, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def add_volume( + self, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + opacityscale=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuehoverformat=None, + valuesrc=None, + visible=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + row=None, + col=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Volume trace + + Draws volume trace between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.volume.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties + spaceframe + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties + surface + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Volume + + new_trace = Volume( + autocolorscale=autocolorscale, + caps=caps, + cauto=cauto, + cmax=cmax, + cmid=cmid, + cmin=cmin, + coloraxis=coloraxis, + colorbar=colorbar, + colorscale=colorscale, + contour=contour, + customdata=customdata, + customdatasrc=customdatasrc, + flatshading=flatshading, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + isomax=isomax, + isomin=isomin, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + lighting=lighting, + lightposition=lightposition, + meta=meta, + metasrc=metasrc, + name=name, + opacity=opacity, + opacityscale=opacityscale, + reversescale=reversescale, + scene=scene, + showlegend=showlegend, + showscale=showscale, + slices=slices, + spaceframe=spaceframe, + stream=stream, + surface=surface, + text=text, + textsrc=textsrc, + uid=uid, + uirevision=uirevision, + value=value, + valuehoverformat=valuehoverformat, + valuesrc=valuesrc, + visible=visible, + x=x, + xhoverformat=xhoverformat, + xsrc=xsrc, + y=y, + yhoverformat=yhoverformat, + ysrc=ysrc, + z=z, + zhoverformat=zhoverformat, + zsrc=zsrc, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col) + + def add_waterfall( + self, + alignmentgroup=None, + base=None, + cliponaxis=None, + connector=None, + constraintext=None, + customdata=None, + customdatasrc=None, + decreasing=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + measure=None, + measuresrc=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + totals=None, + uid=None, + uirevision=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Add a new Waterfall trace + + Draws waterfall trace which is useful graph to displays the + contribution of various elements (either positive or negative) + in a bar chart. The data visualized by the span of the bars is + set in `y` if `orientation` is set to "v" (the default) and the + labels are set in `x`. By setting `orientation` to "h", the + roles are interchanged. + + Parameters + ---------- + 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. + base + Sets where the bar base is drawn (in position axis + units). + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta` and `final`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.waterfall.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + measure + An array containing types of values. By default the + values are considered as 'relative'. However; it is + possible to use 'total' to compute the sums. Also + 'absolute' could be applied to reset the computed total + or to declare an initial value where needed. + measuresrc + Sets the source reference on Chart Studio Cloud for + `measure`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple waterfalls, totals are + computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta`, `final` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + totals + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + row : 'all', int or None (default) + Subplot row index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + rows in the specified column(s). + col : 'all', int or None (default) + Subplot col index (starting from 1) for the trace to be + added. Only valid if figure was created using + `plotly.tools.make_subplots`.If 'all', addresses all + columns in the specified row(s). + secondary_y: boolean or None (default None) + If True, associate this trace with the secondary y-axis of the + subplot at the specified row and col. Only valid if all of the + following conditions are satisfied: + * The figure was created using `plotly.subplots.make_subplots`. + * The row and col arguments are not None + * The subplot at the specified row and col has type xy + (which is the default) and secondary_y True. These + properties are specified in the specs argument to + make_subplots. See the make_subplots docstring for more info. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import Waterfall + + new_trace = Waterfall( + alignmentgroup=alignmentgroup, + base=base, + cliponaxis=cliponaxis, + connector=connector, + constraintext=constraintext, + customdata=customdata, + customdatasrc=customdatasrc, + decreasing=decreasing, + dx=dx, + dy=dy, + hoverinfo=hoverinfo, + hoverinfosrc=hoverinfosrc, + hoverlabel=hoverlabel, + hovertemplate=hovertemplate, + hovertemplatesrc=hovertemplatesrc, + hovertext=hovertext, + hovertextsrc=hovertextsrc, + ids=ids, + idssrc=idssrc, + increasing=increasing, + insidetextanchor=insidetextanchor, + insidetextfont=insidetextfont, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + measure=measure, + measuresrc=measuresrc, + meta=meta, + metasrc=metasrc, + name=name, + offset=offset, + offsetgroup=offsetgroup, + offsetsrc=offsetsrc, + opacity=opacity, + orientation=orientation, + outsidetextfont=outsidetextfont, + selectedpoints=selectedpoints, + showlegend=showlegend, + stream=stream, + text=text, + textangle=textangle, + textfont=textfont, + textinfo=textinfo, + textposition=textposition, + textpositionsrc=textpositionsrc, + textsrc=textsrc, + texttemplate=texttemplate, + texttemplatesrc=texttemplatesrc, + totals=totals, + uid=uid, + uirevision=uirevision, + visible=visible, + width=width, + widthsrc=widthsrc, + x=x, + x0=x0, + xaxis=xaxis, + xhoverformat=xhoverformat, + xperiod=xperiod, + xperiod0=xperiod0, + xperiodalignment=xperiodalignment, + xsrc=xsrc, + y=y, + y0=y0, + yaxis=yaxis, + yhoverformat=yhoverformat, + yperiod=yperiod, + yperiod0=yperiod0, + yperiodalignment=yperiodalignment, + ysrc=ysrc, + zorder=zorder, + **kwargs, + ) + return self.add_trace(new_trace, row=row, col=col, secondary_y=secondary_y) + + def select_coloraxes(self, selector=None, row=None, col=None): + """ + Select coloraxis subplot objects from a particular subplot cell + and/or coloraxis subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + coloraxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all coloraxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + coloraxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of coloraxis objects to select. + To select coloraxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all coloraxis objects are selected. + Returns + ------- + generator + Generator that iterates through all of the coloraxis + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("coloraxis", selector, row, col) + + def for_each_coloraxis( + self, fn, selector=None, row=None, col=None + ) -> "FigureWidget": + """ + Apply a function to all coloraxis objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single coloraxis object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + coloraxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all coloraxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + coloraxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of coloraxis objects to select. + To select coloraxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all coloraxis objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_coloraxes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_coloraxes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all coloraxis objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + coloraxis objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + coloraxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all coloraxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + coloraxis and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of coloraxis objects to select. + To select coloraxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all coloraxis objects are selected. + **kwargs + Additional property updates to apply to each selected + coloraxis object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_coloraxes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_geos(self, selector=None, row=None, col=None): + """ + Select geo subplot objects from a particular subplot cell + and/or geo subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + geo objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all geo objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + geo and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of geo objects to select. + To select geo objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all geo objects are selected. + Returns + ------- + generator + Generator that iterates through all of the geo + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("geo", selector, row, col) + + def for_each_geo(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all geo objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single geo object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + geo objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all geo objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + geo and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of geo objects to select. + To select geo objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all geo objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_geos(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_geos( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all geo objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + geo objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + geo objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all geo objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + geo and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of geo objects to select. + To select geo objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all geo objects are selected. + **kwargs + Additional property updates to apply to each selected + geo object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_geos(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_legends(self, selector=None, row=None, col=None): + """ + Select legend subplot objects from a particular subplot cell + and/or legend subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + legend objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all legend objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + legend and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of legend objects to select. + To select legend objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all legend objects are selected. + Returns + ------- + generator + Generator that iterates through all of the legend + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("legend", selector, row, col) + + def for_each_legend(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all legend objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single legend object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + legend objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all legend objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + legend and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of legend objects to select. + To select legend objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all legend objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_legends(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_legends( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all legend objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + legend objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + legend objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all legend objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + legend and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of legend objects to select. + To select legend objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all legend objects are selected. + **kwargs + Additional property updates to apply to each selected + legend object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_legends(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_maps(self, selector=None, row=None, col=None): + """ + Select map subplot objects from a particular subplot cell + and/or map subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + map objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all map objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + map and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of map objects to select. + To select map objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all map objects are selected. + Returns + ------- + generator + Generator that iterates through all of the map + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("map", selector, row, col) + + def for_each_map(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all map objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single map object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + map objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all map objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + map and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of map objects to select. + To select map objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all map objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_maps(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_maps( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all map objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + map objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + map objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all map objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + map and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of map objects to select. + To select map objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all map objects are selected. + **kwargs + Additional property updates to apply to each selected + map object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_maps(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_mapboxes(self, selector=None, row=None, col=None): + """ + Select mapbox subplot objects from a particular subplot cell + and/or mapbox subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + mapbox objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all mapbox objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + mapbox and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of mapbox objects to select. + To select mapbox objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all mapbox objects are selected. + Returns + ------- + generator + Generator that iterates through all of the mapbox + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("mapbox", selector, row, col) + + def for_each_mapbox(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all mapbox objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single mapbox object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + mapbox objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all mapbox objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + mapbox and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of mapbox objects to select. + To select mapbox objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all mapbox objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_mapboxes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_mapboxes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all mapbox objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + mapbox objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + mapbox objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all mapbox objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + mapbox and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of mapbox objects to select. + To select mapbox objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all mapbox objects are selected. + **kwargs + Additional property updates to apply to each selected + mapbox object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_mapboxes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_polars(self, selector=None, row=None, col=None): + """ + Select polar subplot objects from a particular subplot cell + and/or polar subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + polar objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all polar objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + polar and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of polar objects to select. + To select polar objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all polar objects are selected. + Returns + ------- + generator + Generator that iterates through all of the polar + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("polar", selector, row, col) + + def for_each_polar(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all polar objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single polar object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + polar objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all polar objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + polar and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of polar objects to select. + To select polar objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all polar objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_polars(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_polars( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all polar objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + polar objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + polar objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all polar objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + polar and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of polar objects to select. + To select polar objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all polar objects are selected. + **kwargs + Additional property updates to apply to each selected + polar object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_polars(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_scenes(self, selector=None, row=None, col=None): + """ + Select scene subplot objects from a particular subplot cell + and/or scene subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + scene objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all scene objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + scene and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of scene objects to select. + To select scene objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all scene objects are selected. + Returns + ------- + generator + Generator that iterates through all of the scene + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("scene", selector, row, col) + + def for_each_scene(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all scene objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single scene object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + scene objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all scene objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + scene and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of scene objects to select. + To select scene objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all scene objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_scenes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_scenes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all scene objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + scene objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + scene objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all scene objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + scene and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of scene objects to select. + To select scene objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all scene objects are selected. + **kwargs + Additional property updates to apply to each selected + scene object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_scenes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_smiths(self, selector=None, row=None, col=None): + """ + Select smith subplot objects from a particular subplot cell + and/or smith subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + smith objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all smith objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + smith and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of smith objects to select. + To select smith objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all smith objects are selected. + Returns + ------- + generator + Generator that iterates through all of the smith + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("smith", selector, row, col) + + def for_each_smith(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all smith objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single smith object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + smith objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all smith objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + smith and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of smith objects to select. + To select smith objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all smith objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_smiths(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_smiths( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all smith objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + smith objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + smith objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all smith objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + smith and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of smith objects to select. + To select smith objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all smith objects are selected. + **kwargs + Additional property updates to apply to each selected + smith object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_smiths(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_ternaries(self, selector=None, row=None, col=None): + """ + Select ternary subplot objects from a particular subplot cell + and/or ternary subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + ternary objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all ternary objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + ternary and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of ternary objects to select. + To select ternary objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all ternary objects are selected. + Returns + ------- + generator + Generator that iterates through all of the ternary + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("ternary", selector, row, col) + + def for_each_ternary(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all ternary objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single ternary object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + ternary objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all ternary objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + ternary and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of ternary objects to select. + To select ternary objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all ternary objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_ternaries(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_ternaries( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all ternary objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + ternary objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + ternary objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all ternary objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + ternary and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of ternary objects to select. + To select ternary objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all ternary objects are selected. + **kwargs + Additional property updates to apply to each selected + ternary object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_ternaries(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_xaxes(self, selector=None, row=None, col=None): + """ + Select xaxis subplot objects from a particular subplot cell + and/or xaxis subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + xaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all xaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + xaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of xaxis objects to select. + To select xaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all xaxis objects are selected. + Returns + ------- + generator + Generator that iterates through all of the xaxis + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix("xaxis", selector, row, col) + + def for_each_xaxis(self, fn, selector=None, row=None, col=None) -> "FigureWidget": + """ + Apply a function to all xaxis objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single xaxis object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + xaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all xaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + xaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of xaxis objects to select. + To select xaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all xaxis objects are selected. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_xaxes(selector=selector, row=row, col=col): + fn(obj) + + return self + + def update_xaxes( + self, patch=None, selector=None, overwrite=False, row=None, col=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all xaxis objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + xaxis objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + xaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all xaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + xaxis and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of xaxis objects to select. + To select xaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all xaxis objects are selected. + **kwargs + Additional property updates to apply to each selected + xaxis object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_xaxes(selector=selector, row=row, col=col): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_yaxes(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select yaxis subplot objects from a particular subplot cell + and/or yaxis subplot objects that satisfy custom selection + criteria. + + Parameters + ---------- + selector: dict, function, or None (default None) + Dict to use as selection criteria. + yaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all yaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + yaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of yaxis objects to select. + To select yaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all yaxis objects are selected. + secondary_y: boolean or None (default None) + * If True, only select yaxis objects associated with the secondary + y-axis of the subplot. + * If False, only select yaxis objects associated with the primary + y-axis of the subplot. + * If None (the default), do not filter yaxis objects based on + a secondary y-axis condition. + + To select yaxis objects by secondary y-axis, the Figure must + have been created using plotly.subplots.make_subplots. See + the docstring for the specs argument to make_subplots for more + info on creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the yaxis + objects that satisfy all of the specified selection criteria + """ + + return self._select_layout_subplots_by_prefix( + "yaxis", selector, row, col, secondary_y=secondary_y + ) + + def for_each_yaxis( + self, fn, selector=None, row=None, col=None, secondary_y=None + ) -> "FigureWidget": + """ + Apply a function to all yaxis objects that satisfy the + specified selection criteria + + Parameters + ---------- + fn: + Function that inputs a single yaxis object. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + yaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all yaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + yaxis and those for which the function returned True will + be in the selection. + row, col: int or None (default None) + Subplot row and column index of yaxis objects to select. + To select yaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all yaxis objects are selected. + secondary_y: boolean or None (default None) + * If True, only select yaxis objects associated with the secondary + y-axis of the subplot. + * If False, only select yaxis objects associated with the primary + y-axis of the subplot. + * If None (the default), do not filter yaxis objects based on + a secondary y-axis condition. + + To select yaxis objects by secondary y-axis, the Figure must + have been created using plotly.subplots.make_subplots. See + the docstring for the specs argument to make_subplots for more + info on creating subplots with secondary y-axes. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_yaxes( + selector=selector, row=row, col=col, secondary_y=secondary_y + ): + fn(obj) + + return self + + def update_yaxes( + self, + patch=None, + selector=None, + overwrite=False, + row=None, + col=None, + secondary_y=None, + **kwargs, + ) -> "FigureWidget": + """ + Perform a property update operation on all yaxis objects + that satisfy the specified selection criteria + + Parameters + ---------- + patch: dict + Dictionary of property updates to be applied to all + yaxis objects that satisfy the selection criteria. + selector: dict, function, or None (default None) + Dict to use as selection criteria. + yaxis objects will be selected if they contain + properties corresponding to all of the dictionary's keys, with + values that exactly match the supplied values. If None + (the default), all yaxis objects are selected. If a + function, it must be a function accepting a single argument and + returning a boolean. The function will be called on each + yaxis and those for which the function returned True will + be in the selection. + overwrite: bool + If True, overwrite existing properties. If False, apply updates + to existing properties recursively, preserving existing + properties that are not specified in the update operation. + row, col: int or None (default None) + Subplot row and column index of yaxis objects to select. + To select yaxis objects by row and column, the Figure + must have been created using plotly.subplots.make_subplots. + If None (the default), all yaxis objects are selected. + secondary_y: boolean or None (default None) + * If True, only select yaxis objects associated with the secondary + y-axis of the subplot. + * If False, only select yaxis objects associated with the primary + y-axis of the subplot. + * If None (the default), do not filter yaxis objects based on + a secondary y-axis condition. + + To select yaxis objects by secondary y-axis, the Figure must + have been created using plotly.subplots.make_subplots. See + the docstring for the specs argument to make_subplots for more + info on creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected + yaxis object. If a property is specified in + both patch and in **kwargs then the one in **kwargs + takes precedence. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self.select_yaxes( + selector=selector, row=row, col=col, secondary_y=secondary_y + ): + obj.update(patch, overwrite=overwrite, **kwargs) + + return self + + def select_annotations(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select annotations from a particular subplot cell and/or annotations + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all annotations are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each annotation and those for which the function returned True + will be in the selection. If an int N, the Nth annotation matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of annotations to select. + To select annotations by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + annotation that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all annotations are selected. + secondary_y: boolean or None (default None) + * If True, only select annotations associated with the secondary + y-axis of the subplot. + * If False, only select annotations associated with the primary + y-axis of the subplot. + * If None (the default), do not filter annotations based on secondary + y-axis. + + To select annotations by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the annotations that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "annotations", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_annotation( + self, fn, selector=None, row=None, col=None, secondary_y=None + ): + """ + Apply a function to all annotations that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single annotation object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all annotations are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each annotation and those for which the function returned True + will be in the selection. If an int N, the Nth annotation matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of annotations to select. + To select annotations by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + annotations that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all annotations are selected. + secondary_y: boolean or None (default None) + * If True, only select annotations associated with the secondary + y-axis of the subplot. + * If False, only select annotations associated with the primary + y-axis of the subplot. + * If None (the default), do not filter annotations based on secondary + y-axis. + + To select annotations by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="annotations", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_annotations( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all annotations that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all annotations that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all annotations are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each annotation and those for which the function returned True + will be in the selection. If an int N, the Nth annotation matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of annotations to select. + To select annotations by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + annotation that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all annotations are selected. + secondary_y: boolean or None (default None) + * If True, only select annotations associated with the secondary + y-axis of the subplot. + * If False, only select annotations associated with the primary + y-axis of the subplot. + * If None (the default), do not filter annotations based on secondary + y-axis. + + To select annotations by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected annotation. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="annotations", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_annotation( + self, + arg=None, + align=None, + arrowcolor=None, + arrowhead=None, + arrowside=None, + arrowsize=None, + arrowwidth=None, + ax=None, + axref=None, + ay=None, + ayref=None, + bgcolor=None, + bordercolor=None, + borderpad=None, + borderwidth=None, + captureevents=None, + clicktoshow=None, + font=None, + height=None, + hoverlabel=None, + hovertext=None, + name=None, + opacity=None, + showarrow=None, + standoff=None, + startarrowhead=None, + startarrowsize=None, + startstandoff=None, + templateitemname=None, + text=None, + textangle=None, + valign=None, + visible=None, + width=None, + x=None, + xanchor=None, + xclick=None, + xref=None, + xshift=None, + y=None, + yanchor=None, + yclick=None, + yref=None, + yshift=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "FigureWidget": + """ + Create and add a new annotation to the figure's layout + + Parameters + ---------- + arg + instance of Annotation or dict with compatible + properties + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head. If `axref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from right + to left (left to right). If `axref` is not `pixel` and + is exactly the same as `xref`, this is an absolute + value on that axis, like `x`, specified in the same + coordinates as `xref`. + axref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. In order for absolute + positioning of the arrow to work, "axref" must be + exactly the same as "xref", otherwise "axref" will + revert to "pixel" (explained next). For relative + positioning, "axref" can be set to "pixel", in which + case the "ax" value is specified in pixels relative to + "x". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + ay + Sets the y component of the arrow tail about the arrow + head. If `ayref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from bottom + to top (top to bottom). If `ayref` is not `pixel` and + is exactly the same as `yref`, this is an absolute + value on that axis, like `y`, specified in the same + coordinates as `yref`. + ayref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. In order for absolute + positioning of the arrow to work, "ayref" must be + exactly the same as "yref", otherwise "ayref" will + revert to "pixel" (explained next). For relative + positioning, "ayref" can be set to "pixel", in which + case the "ay" value is specified in pixels relative to + "y". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the plot. If + you click a data point that exactly matches the `x` and + `y` values of this annotation, and it is hidden + (visible: false), it will appear. In "onoff" mode, you + must click the same point again to make it disappear, + so if you click multiple points, you can show multiple + annotations. In "onout" mode, a click anywhere else in + the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for example to + label the side of a bar. To label markers though, + `standoff` is preferred over `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xclick + Toggle this annotation when clicking a data point whose + `x` value is `xclick` rather than the annotation's `x` + value. + xref + Sets the annotation's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yclick + Toggle this annotation when clicking a data point whose + `y` value is `yclick` rather than the annotation's `y` + value. + yref + Sets the annotation's y coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + row + Subplot row for annotation. If 'all', addresses all + rows in the specified column(s). + col + Subplot column for annotation. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add annotation to secondary y-axis + exclude_empty_subplots + If True, annotation will not be added to subplots + without traces. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Annotation( + arg, + align=align, + arrowcolor=arrowcolor, + arrowhead=arrowhead, + arrowside=arrowside, + arrowsize=arrowsize, + arrowwidth=arrowwidth, + ax=ax, + axref=axref, + ay=ay, + ayref=ayref, + bgcolor=bgcolor, + bordercolor=bordercolor, + borderpad=borderpad, + borderwidth=borderwidth, + captureevents=captureevents, + clicktoshow=clicktoshow, + font=font, + height=height, + hoverlabel=hoverlabel, + hovertext=hovertext, + name=name, + opacity=opacity, + showarrow=showarrow, + standoff=standoff, + startarrowhead=startarrowhead, + startarrowsize=startarrowsize, + startstandoff=startstandoff, + templateitemname=templateitemname, + text=text, + textangle=textangle, + valign=valign, + visible=visible, + width=width, + x=x, + xanchor=xanchor, + xclick=xclick, + xref=xref, + xshift=xshift, + y=y, + yanchor=yanchor, + yclick=yclick, + yref=yref, + yshift=yshift, + **kwargs, + ) + return self._add_annotation_like( + "annotation", + "annotations", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) + + def select_layout_images(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select images from a particular subplot cell and/or images + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all images are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each image and those for which the function returned True + will be in the selection. If an int N, the Nth image matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of images to select. + To select images by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + image that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all images are selected. + secondary_y: boolean or None (default None) + * If True, only select images associated with the secondary + y-axis of the subplot. + * If False, only select images associated with the primary + y-axis of the subplot. + * If None (the default), do not filter images based on secondary + y-axis. + + To select images by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the images that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "images", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_layout_image( + self, fn, selector=None, row=None, col=None, secondary_y=None + ): + """ + Apply a function to all images that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single image object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all images are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each image and those for which the function returned True + will be in the selection. If an int N, the Nth image matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of images to select. + To select images by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + images that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all images are selected. + secondary_y: boolean or None (default None) + * If True, only select images associated with the secondary + y-axis of the subplot. + * If False, only select images associated with the primary + y-axis of the subplot. + * If None (the default), do not filter images based on secondary + y-axis. + + To select images by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="images", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_layout_images( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all images that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all images that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all images are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each image and those for which the function returned True + will be in the selection. If an int N, the Nth image matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of images to select. + To select images by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + image that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all images are selected. + secondary_y: boolean or None (default None) + * If True, only select images associated with the secondary + y-axis of the subplot. + * If False, only select images associated with the primary + y-axis of the subplot. + * If None (the default), do not filter images based on secondary + y-axis. + + To select images by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected image. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="images", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_layout_image( + self, + arg=None, + layer=None, + name=None, + opacity=None, + sizex=None, + sizey=None, + sizing=None, + source=None, + templateitemname=None, + visible=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "FigureWidget": + """ + Create and add a new image to the figure's layout + + Parameters + ---------- + arg + instance of Image or dict with compatible properties + layer + Specifies whether images are drawn below or above + traces. When `xref` and `yref` are both set to `paper`, + image is drawn below the entire plot area. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The image + will be sized based on the `position` value. When + `xref` is set to `paper`, units are sized relative to + the plot width. When `xref` ends with ` domain`, units + are sized relative to the axis width. + sizey + Sets the image container size vertically. The image + will be sized based on the `position` value. When + `yref` is set to `paper`, units are sized relative to + the plot height. When `yref` ends with ` domain`, units + are sized relative to the axis height. + sizing + Specifies which dimension of the image to constrain. + source + Specifies the URL of the image to be used. The URL must + be accessible from the domain where the plot code is + run, and can be either relative or absolute. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this image is visible. + x + Sets the image's x position. When `xref` is set to + `paper`, units are sized relative to the plot height. + See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y + Sets the image's y position. When `yref` is set to + `paper`, units are sized relative to the plot height. + See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + row + Subplot row for image. If 'all', addresses all rows in + the specified column(s). + col + Subplot column for image. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add image to secondary y-axis + exclude_empty_subplots + If True, image will not be added to subplots without + traces. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Image( + arg, + layer=layer, + name=name, + opacity=opacity, + sizex=sizex, + sizey=sizey, + sizing=sizing, + source=source, + templateitemname=templateitemname, + visible=visible, + x=x, + xanchor=xanchor, + xref=xref, + y=y, + yanchor=yanchor, + yref=yref, + **kwargs, + ) + return self._add_annotation_like( + "image", + "images", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) + + def select_selections(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select selections from a particular subplot cell and/or selections + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all selections are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each selection and those for which the function returned True + will be in the selection. If an int N, the Nth selection matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of selections to select. + To select selections by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + selection that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all selections are selected. + secondary_y: boolean or None (default None) + * If True, only select selections associated with the secondary + y-axis of the subplot. + * If False, only select selections associated with the primary + y-axis of the subplot. + * If None (the default), do not filter selections based on secondary + y-axis. + + To select selections by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the selections that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "selections", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_selection( + self, fn, selector=None, row=None, col=None, secondary_y=None + ): + """ + Apply a function to all selections that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single selection object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all selections are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each selection and those for which the function returned True + will be in the selection. If an int N, the Nth selection matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of selections to select. + To select selections by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + selections that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all selections are selected. + secondary_y: boolean or None (default None) + * If True, only select selections associated with the secondary + y-axis of the subplot. + * If False, only select selections associated with the primary + y-axis of the subplot. + * If None (the default), do not filter selections based on secondary + y-axis. + + To select selections by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="selections", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_selections( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all selections that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all selections that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all selections are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each selection and those for which the function returned True + will be in the selection. If an int N, the Nth selection matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of selections to select. + To select selections by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + selection that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all selections are selected. + secondary_y: boolean or None (default None) + * If True, only select selections associated with the secondary + y-axis of the subplot. + * If False, only select selections associated with the primary + y-axis of the subplot. + * If None (the default), do not filter selections based on secondary + y-axis. + + To select selections by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected selection. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="selections", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_selection( + self, + arg=None, + line=None, + name=None, + opacity=None, + path=None, + templateitemname=None, + type=None, + x0=None, + x1=None, + xref=None, + y0=None, + y1=None, + yref=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "FigureWidget": + """ + Create and add a new selection to the figure's layout + + Parameters + ---------- + arg + instance of Selection or dict with compatible + properties + line + :class:`plotly.graph_objects.layout.selection.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the selection. + path + For `type` "path" - a valid SVG path similar to + `shapes.path` in data coordinates. Allowed segments + are: M, L and Z. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the selection type to be drawn. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom + SVG path using `path`. + x0 + Sets the selection's starting x position. + x1 + Sets the selection's end x position. + xref + Sets the selection's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y0 + Sets the selection's starting y position. + y1 + Sets the selection's end y position. + yref + Sets the selection's x coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + row + Subplot row for selection. If 'all', addresses all rows + in the specified column(s). + col + Subplot column for selection. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add selection to secondary y-axis + exclude_empty_subplots + If True, selection will not be added to subplots + without traces. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Selection( + arg, + line=line, + name=name, + opacity=opacity, + path=path, + templateitemname=templateitemname, + type=type, + x0=x0, + x1=x1, + xref=xref, + y0=y0, + y1=y1, + yref=yref, + **kwargs, + ) + return self._add_annotation_like( + "selection", + "selections", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) + + def select_shapes(self, selector=None, row=None, col=None, secondary_y=None): + """ + Select shapes from a particular subplot cell and/or shapes + that satisfy custom selection criteria. + + Parameters + ---------- + selector: dict, function, int, str, or None (default None) + Dict to use as selection criteria. + Annotations will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all shapes are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each shape and those for which the function returned True + will be in the selection. If an int N, the Nth shape matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of shapes to select. + To select shapes by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + shape that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all shapes are selected. + secondary_y: boolean or None (default None) + * If True, only select shapes associated with the secondary + y-axis of the subplot. + * If False, only select shapes associated with the primary + y-axis of the subplot. + * If None (the default), do not filter shapes based on secondary + y-axis. + + To select shapes by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + generator + Generator that iterates through all of the shapes that satisfy + all of the specified selection criteria + """ + return self._select_annotations_like( + "shapes", selector=selector, row=row, col=col, secondary_y=secondary_y + ) + + def for_each_shape(self, fn, selector=None, row=None, col=None, secondary_y=None): + """ + Apply a function to all shapes that satisfy the specified selection + criteria + + Parameters + ---------- + fn: + Function that inputs a single shape object. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all shapes are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each shape and those for which the function returned True + will be in the selection. If an int N, the Nth shape matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of shapes to select. + To select shapes by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + shapes that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all shapes are selected. + secondary_y: boolean or None (default None) + * If True, only select shapes associated with the secondary + y-axis of the subplot. + * If False, only select shapes associated with the primary + y-axis of the subplot. + * If None (the default), do not filter shapes based on secondary + y-axis. + + To select shapes by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="shapes", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + fn(obj) + + return self + + def update_shapes( + self, patch=None, selector=None, row=None, col=None, secondary_y=None, **kwargs + ) -> "FigureWidget": + """ + Perform a property update operation on all shapes that satisfy the + specified selection criteria + + Parameters + ---------- + patch: dict or None (default None) + Dictionary of property updates to be applied to all shapes that + satisfy the selection criteria. + selector: dict, function, int, str or None (default None) + Dict to use as selection criteria. + Traces will be selected if they contain properties corresponding + to all of the dictionary's keys, with values that exactly match + the supplied values. If None (the default), all shapes are + selected. If a function, it must be a function accepting a single + argument and returning a boolean. The function will be called on + each shape and those for which the function returned True + will be in the selection. If an int N, the Nth shape matching row + and col will be selected (N can be negative). If a string S, the selector + is equivalent to dict(type=S). + row, col: int or None (default None) + Subplot row and column index of shapes to select. + To select shapes by row and column, the Figure must have been + created using plotly.subplots.make_subplots. To select only those + shape that are in paper coordinates, set row and col to the + string 'paper'. If None (the default), all shapes are selected. + secondary_y: boolean or None (default None) + * If True, only select shapes associated with the secondary + y-axis of the subplot. + * If False, only select shapes associated with the primary + y-axis of the subplot. + * If None (the default), do not filter shapes based on secondary + y-axis. + + To select shapes by secondary y-axis, the Figure must have been + created using plotly.subplots.make_subplots. See the docstring + for the specs argument to make_subplots for more info on + creating subplots with secondary y-axes. + **kwargs + Additional property updates to apply to each selected shape. If + a property is specified in both patch and in **kwargs then the + one in **kwargs takes precedence. + + Returns + ------- + self + Returns the FigureWidget object that the method was called on + """ + for obj in self._select_annotations_like( + prop="shapes", + selector=selector, + row=row, + col=col, + secondary_y=secondary_y, + ): + obj.update(patch, **kwargs) + + return self + + def add_shape( + self, + arg=None, + editable=None, + fillcolor=None, + fillrule=None, + label=None, + layer=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + name=None, + opacity=None, + path=None, + showlegend=None, + templateitemname=None, + type=None, + visible=None, + x0=None, + x0shift=None, + x1=None, + x1shift=None, + xanchor=None, + xref=None, + xsizemode=None, + y0=None, + y0shift=None, + y1=None, + y1shift=None, + yanchor=None, + yref=None, + ysizemode=None, + row=None, + col=None, + secondary_y=None, + exclude_empty_subplots=None, + **kwargs, + ) -> "FigureWidget": + """ + Create and add a new shape to the figure's layout + + Parameters + ---------- + arg + instance of Shape or dict with compatible properties + editable + Determines whether the shape could be activated for + edit or not. Has no effect when the older editable + shapes mode is enabled via `config.editable` or + `config.edits.shapePosition`. + fillcolor + Sets the color filling the shape's interior. Only + applies to closed shapes. + fillrule + Determines which regions of complex paths constitute + the interior. For more info please visit + https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + label + :class:`plotly.graph_objects.layout.shape.Label` + instance or dict with compatible properties + layer + Specifies whether shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or + above traces ("above"). + legend + Sets the reference to a legend to show this shape in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this shape. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.layout.shape.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this shape. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this shape. + line + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the pixel + values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and taken + unmodified as pixels relative to `xanchor` and + `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not + relative. So the allowed segments are: M, L, H, V, Q, + C, T, S, and Z arcs (A) are not allowed because radius + rx and ry are relative. In the future we could consider + supporting relative commands, but we would have to + decide on how to handle date and log axes. Note that + even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. + no chained "polybezier" commands - specify the segment + type for each one. On category axes, values are numbers + scaled to the serial numbers of categories because + using the categories themselves there would be no way + to describe fractional positions On data axes: because + space and T are both normal components of path strings, + we can't use either to separate date from time parts. + Therefore we'll use underscore for this purpose: + 2015-02-21_13:45:56.789 + showlegend + Determines whether or not this shape is shown in the + legend. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If "line", a line + is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect + to the axes' sizing mode. If "circle", a circle is + drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with + respect to the axes' sizing mode. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to + the axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' sizing + mode. + visible + Determines whether or not this shape is visible. If + "legendonly", the shape is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x0 + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + x0shift + Shifts `x0` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + x1shift + Shifts `x1` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + xanchor + Only relevant in conjunction with `xsizemode` set to + "pixel". Specifies the anchor point on the x axis to + which `x0`, `x1` and x coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `xsizemode` not + set to "pixel". + xref + Sets the shape's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xsizemode + Sets the shapes's sizing mode along the x axis. If set + to "scaled", `x0`, `x1` and x coordinates within `path` + refer to data values on the x axis or a fraction of the + plot area's width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in terms of + data or plot fraction but `x0`, `x1` and x coordinates + within `path` are pixels relative to `xanchor`. This + way, the shape can have a fixed width while maintaining + a position relative to data or plot fraction. + y0 + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + y0shift + Shifts `y0` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + y1shift + Shifts `y1` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + yanchor + Only relevant in conjunction with `ysizemode` set to + "pixel". Specifies the anchor point on the y axis to + which `y0`, `y1` and y coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `ysizemode` not + set to "pixel". + yref + Sets the shape's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + ysizemode + Sets the shapes's sizing mode along the y axis. If set + to "scaled", `y0`, `y1` and y coordinates within `path` + refer to data values on the y axis or a fraction of the + plot area's height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in terms of + data or plot fraction but `y0`, `y1` and y coordinates + within `path` are pixels relative to `yanchor`. This + way, the shape can have a fixed height while + maintaining a position relative to data or plot + fraction. + row + Subplot row for shape. If 'all', addresses all rows in + the specified column(s). + col + Subplot column for shape. If 'all', addresses all + columns in the specified row(s). + secondary_y + Whether to add shape to secondary y-axis + exclude_empty_subplots + If True, shape will not be added to subplots without + traces. + + Returns + ------- + FigureWidget + """ + from plotly.graph_objs import layout as _layout + + new_obj = _layout.Shape( + arg, + editable=editable, + fillcolor=fillcolor, + fillrule=fillrule, + label=label, + layer=layer, + legend=legend, + legendgroup=legendgroup, + legendgrouptitle=legendgrouptitle, + legendrank=legendrank, + legendwidth=legendwidth, + line=line, + name=name, + opacity=opacity, + path=path, + showlegend=showlegend, + templateitemname=templateitemname, + type=type, + visible=visible, + x0=x0, + x0shift=x0shift, + x1=x1, + x1shift=x1shift, + xanchor=xanchor, + xref=xref, + xsizemode=xsizemode, + y0=y0, + y0shift=y0shift, + y1=y1, + y1shift=y1shift, + yanchor=yanchor, + yref=yref, + ysizemode=ysizemode, + **kwargs, + ) + return self._add_annotation_like( + "shape", + "shapes", + new_obj, + row=row, + col=col, + secondary_y=secondary_y, + exclude_empty_subplots=exclude_empty_subplots, + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_frame.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_frame.py new file mode 100644 index 0000000..703e8d2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_frame.py @@ -0,0 +1,220 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseFrameHierarchyType as _BaseFrameHierarchyType +import copy as _copy + + +class Frame(_BaseFrameHierarchyType): + _parent_path_str = "" + _path_str = "frame" + _valid_props = {"baseframe", "data", "group", "layout", "name", "traces"} + + @property + def baseframe(self): + """ + The name of the frame into which this frame's properties are + merged before applying. This is used to unify properties and + avoid needing to specify the same values for the same + properties in multiple frames. + + The 'baseframe' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["baseframe"] + + @baseframe.setter + def baseframe(self, val): + self["baseframe"] = val + + @property + def data(self): + """ + A list of traces this frame modifies. The format is identical + to the normal trace definition. + + Returns + ------- + Any + """ + return self["data"] + + @data.setter + def data(self, val): + self["data"] = val + + @property + def group(self): + """ + An identifier that specifies the group to which the frame + belongs, used by animate to select a subset of frames. + + The 'group' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["group"] + + @group.setter + def group(self, val): + self["group"] = val + + @property + def layout(self): + """ + Layout properties which this frame modifies. The format is + identical to the normal layout definition. + + Returns + ------- + Any + """ + return self["layout"] + + @layout.setter + def layout(self, val): + self["layout"] = val + + @property + def name(self): + """ + A label by which to identify the frame + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def traces(self): + """ + A list of trace indices that identify the respective traces in + the data attribute + + The 'traces' property accepts values of any type + + Returns + ------- + Any + """ + return self["traces"] + + @traces.setter + def traces(self, val): + self["traces"] = val + + @property + def _prop_descriptions(self): + return """\ + baseframe + The name of the frame into which this frame's + properties are merged before applying. This is used to + unify properties and avoid needing to specify the same + values for the same properties in multiple frames. + data + A list of traces this frame modifies. The format is + identical to the normal trace definition. + group + An identifier that specifies the group to which the + frame belongs, used by animate to select a subset of + frames. + layout + Layout properties which this frame modifies. The format + is identical to the normal layout definition. + name + A label by which to identify the frame + traces + A list of trace indices that identify the respective + traces in the data attribute + """ + + def __init__( + self, + arg=None, + baseframe=None, + data=None, + group=None, + layout=None, + name=None, + traces=None, + **kwargs, + ): + """ + Construct a new Frame object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Frame` + baseframe + The name of the frame into which this frame's + properties are merged before applying. This is used to + unify properties and avoid needing to specify the same + values for the same properties in multiple frames. + data + A list of traces this frame modifies. The format is + identical to the normal trace definition. + group + An identifier that specifies the group to which the + frame belongs, used by animate to select a subset of + frames. + layout + Layout properties which this frame modifies. The format + is identical to the normal layout definition. + name + A label by which to identify the frame + traces + A list of trace indices that identify the respective + traces in the data attribute + + Returns + ------- + Frame + """ + super().__init__("frames") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Frame +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Frame`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("baseframe", arg, baseframe) + self._set_property("data", arg, data) + self._set_property("group", arg, group) + self._set_property("layout", arg, layout) + self._set_property("name", arg, name) + self._set_property("traces", arg, traces) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_funnel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_funnel.py new file mode 100644 index 0000000..fd2682f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_funnel.py @@ -0,0 +1,2392 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Funnel(_BaseTraceType): + _parent_path_str = "" + _path_str = "funnel" + _valid_props = { + "alignmentgroup", + "cliponaxis", + "connector", + "constraintext", + "customdata", + "customdatasrc", + "dx", + "dy", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextanchor", + "insidetextfont", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "offset", + "offsetgroup", + "opacity", + "orientation", + "outsidetextfont", + "selectedpoints", + "showlegend", + "stream", + "text", + "textangle", + "textfont", + "textinfo", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "visible", + "width", + "x", + "x0", + "xaxis", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "y", + "y0", + "yaxis", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def cliponaxis(self): + """ + Determines whether the text nodes are clipped about the subplot + axes. To show the text nodes above axis lines and tick labels, + make sure to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def connector(self): + """ + The 'connector' property is an instance of Connector + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Connector` + - A dict of string/value properties that will be passed + to the Connector constructor + + Returns + ------- + plotly.graph_objs.funnel.Connector + """ + return self["connector"] + + @connector.setter + def connector(self, val): + self["connector"] = val + + @property + def constraintext(self): + """ + Constrain the size of text inside or outside a bar to be no + larger than the bar itself. + + The 'constraintext' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'both', 'none'] + + Returns + ------- + Any + """ + return self["constraintext"] + + @constraintext.setter + def constraintext(self, val): + self["constraintext"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['name', 'x', 'y', 'text', 'percent initial', 'percent previous', 'percent total'] joined with '+' characters + (e.g. 'name+x') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.funnel.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `percentInitial`, + `percentPrevious` and `percentTotal`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextanchor(self): + """ + Determines if texts are kept at center or start/end points in + `textposition` "inside" mode. + + The 'insidetextanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['end', 'middle', 'start'] + + Returns + ------- + Any + """ + return self["insidetextanchor"] + + @insidetextanchor.setter + def insidetextanchor(self, val): + self["insidetextanchor"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `text` lying inside the bar. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.funnel.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.funnel.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.funnel.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def offset(self): + """ + Shifts the position where the bar is drawn (in position axis + units). In "group" barmode, traces that set "offset" will be + excluded and drawn in "overlay" mode instead. + + The 'offset' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Sets the orientation of the funnels. With "v" ("h"), the value + of the each bar spans along the vertical (horizontal). By + default funnels are tend to be oriented horizontally; unless + only "y" array is presented or orientation is set to "v". Also + regarding graphs including only 'horizontal' funnels, + "autorange" on the "y-axis" are set to "reversed". + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `text` lying outside the bar. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.funnel.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.funnel.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle of the tick labels with respect to the bar. For + example, a `tickangle` of -90 draws the tick labels vertically. + With "auto" the texts may automatically be rotated to fit with + the maximum size in bars. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def textfont(self): + """ + Sets the font used for `text`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.funnel.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. In the + case of having multiple funnels, percentages & totals are + computed separately (per trace). + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'percent initial', 'percent previous', 'percent total', 'value'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textposition(self): + """ + Specifies the location of the `text`. "inside" positions `text` + inside, next to the bar end (rotated and scaled if needed). + "outside" positions `text` outside, next to the bar end (scaled + if needed), unless there is another bar stacked on this one, + then the text gets pushed inside. "auto" tries to position + `text` inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If "none", no + text appears. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'auto', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables + `percentInitial`, `percentPrevious`, `percentTotal`, `label` + and `value`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the bar width (in position axis units). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious` and + `percentTotal`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnel.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the funnels. With "v" ("h"), + the value of the each bar spans along the vertical + (horizontal). By default funnels are tend to be + oriented horizontally; unless only "y" array is + presented or orientation is set to "v". Also regarding + graphs including only 'horizontal' funnels, "autorange" + on the "y-axis" are set to "reversed". + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple funnels, percentages & + totals are computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious`, + `percentTotal`, `label` and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + cliponaxis=None, + connector=None, + constraintext=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Funnel object + + Visualize stages in a process using length-encoded bars. This + trace can be used to show data in either a part-to-whole + representation wherein each item appears in a single stage, or + in a "drop-off" representation wherein each item appears in + each stage it traversed. See also the "funnelarea" trace type + for a different approach to visualizing funnel data. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Funnel` + 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. + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.funnel.Connector` instance + or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnel.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious` and + `percentTotal`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnel.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnel.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the funnels. With "v" ("h"), + the value of the each bar spans along the vertical + (horizontal). By default funnels are tend to be + oriented horizontally; unless only "y" array is + presented or orientation is set to "v". Also regarding + graphs including only 'horizontal' funnels, "autorange" + on the "y-axis" are set to "reversed". + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnel.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple funnels, percentages & + totals are computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `percentInitial`, `percentPrevious`, + `percentTotal`, `label` and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Funnel + """ + super().__init__("funnel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Funnel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Funnel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("connector", arg, connector) + self._set_property("constraintext", arg, constraintext) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextanchor", arg, insidetextanchor) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("offset", arg, offset) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "funnel" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_funnelarea.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_funnelarea.py new file mode 100644 index 0000000..50e316b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_funnelarea.py @@ -0,0 +1,1640 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Funnelarea(_BaseTraceType): + _parent_path_str = "" + _path_str = "funnelarea" + _valid_props = { + "aspectratio", + "baseratio", + "customdata", + "customdatasrc", + "dlabel", + "domain", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextfont", + "label0", + "labels", + "labelssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "opacity", + "scalegroup", + "showlegend", + "stream", + "text", + "textfont", + "textinfo", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "title", + "type", + "uid", + "uirevision", + "values", + "valuessrc", + "visible", + } + + @property + def aspectratio(self): + """ + Sets the ratio between height and width + + The 'aspectratio' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["aspectratio"] + + @aspectratio.setter + def aspectratio(self, val): + self["aspectratio"] = val + + @property + def baseratio(self): + """ + Sets the ratio between bottom length and maximum top length. + + The 'baseratio' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["baseratio"] + + @baseratio.setter + def baseratio(self, val): + self["baseratio"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dlabel(self): + """ + Sets the label step. See `label0` for more info. + + The 'dlabel' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dlabel"] + + @dlabel.setter + def dlabel(self, val): + self["dlabel"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `label`, `color`, + `value`, `text` and `percent`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each sector. If a + single string, the same string appears for all data points. If + an array of string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` must contain a + "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `textinfo` lying inside the sector. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def label0(self): + """ + Alternate to `labels`. Builds a numeric set of labels. Use with + `dlabel` where `label0` is the starting label and `dlabel` the + step. + + The 'label0' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["label0"] + + @label0.setter + def label0(self, val): + self["label0"] = val + + @property + def labels(self): + """ + Sets the sector labels. If `labels` entries are duplicated, we + sum associated `values` or simply count occurrences if `values` + is not provided. For other array attributes (including color) + we use the first non-empty entry among all occurrences of the + label. + + The 'labels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["labels"] + + @labels.setter + def labels(self, val): + self["labels"] = val + + @property + def labelssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `labels`. + + The 'labelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelssrc"] + + @labelssrc.setter + def labelssrc(self, val): + self["labelssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def scalegroup(self): + """ + If there are multiple funnelareas that should be sized + according to their totals, link them by providing a non-empty + group id here shared by every trace in the same group. + + The 'scalegroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["scalegroup"] + + @scalegroup.setter + def scalegroup(self, val): + self["scalegroup"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each sector. If trace + `textinfo` contains a "text" flag, these elements will be seen + on the chart. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the font used for `textinfo`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textposition(self): + """ + Specifies the location of the `textinfo`. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `label`, + `color`, `value`, `text` and `percent`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.funnelarea.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def values(self): + """ + Sets the values of the sectors. If omitted, we count + occurrences of each label. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + aspectratio + Sets the ratio between height and width + baseratio + Sets the ratio between bottom length and maximum top + length. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnelarea.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + scalegroup + If there are multiple funnelareas that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + """ + + def __init__( + self, + arg=None, + aspectratio=None, + baseratio=None, + customdata=None, + customdatasrc=None, + dlabel=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + label0=None, + labels=None, + labelssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + scalegroup=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + title=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Funnelarea object + + Visualize stages in a process using area-encoded trapezoids. + This trace can be used to show data in a part-to-whole + representation similar to a "pie" trace, wherein each item + appears in a single stage. See also the "funnel" trace type for + a different approach to visualizing funnel data. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Funnelarea` + aspectratio + Sets the ratio between height and width + baseratio + Sets the ratio between bottom length and maximum top + length. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.funnelarea.Domain` + instance or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.funnelarea.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.funnelarea.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.funnelarea.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + scalegroup + If there are multiple funnelareas that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.funnelarea.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `text` and + `percent`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.funnelarea.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + + Returns + ------- + Funnelarea + """ + super().__init__("funnelarea") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Funnelarea +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Funnelarea`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("aspectratio", arg, aspectratio) + self._set_property("baseratio", arg, baseratio) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dlabel", arg, dlabel) + self._set_property("domain", arg, domain) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("label0", arg, label0) + self._set_property("labels", arg, labels) + self._set_property("labelssrc", arg, labelssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("scalegroup", arg, scalegroup) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("title", arg, title) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + + self._props["type"] = "funnelarea" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_heatmap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_heatmap.py new file mode 100644 index 0000000..0a6819e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_heatmap.py @@ -0,0 +1,2531 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Heatmap(_BaseTraceType): + _parent_path_str = "" + _path_str = "heatmap" + _valid_props = { + "autocolorscale", + "coloraxis", + "colorbar", + "colorscale", + "connectgaps", + "customdata", + "customdatasrc", + "dx", + "dy", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoverongaps", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "meta", + "metasrc", + "name", + "opacity", + "reversescale", + "showlegend", + "showscale", + "stream", + "text", + "textfont", + "textsrc", + "texttemplate", + "transpose", + "type", + "uid", + "uirevision", + "visible", + "x", + "x0", + "xaxis", + "xcalendar", + "xgap", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "xtype", + "y", + "y0", + "yaxis", + "ycalendar", + "ygap", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "ytype", + "z", + "zauto", + "zhoverformat", + "zmax", + "zmid", + "zmin", + "zorder", + "zsmooth", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.heatmap.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the `z` data are filled in. It is defaulted to true if `z` + is a one dimensional array and `zsmooth` is not false; + otherwise it is defaulted to false. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.heatmap.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoverongaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the `z` data have hover labels associated with them. + + The 'hoverongaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["hoverongaps"] + + @hoverongaps.setter + def hoverongaps(self, val): + self["hoverongaps"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.heatmap.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.heatmap.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each z value. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.heatmap.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `x`, `y`, + `z` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def transpose(self): + """ + Transposes the z data. + + The 'transpose' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["transpose"] + + @transpose.setter + def transpose(self, val): + self["transpose"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xgap(self): + """ + Sets the horizontal gap (in pixels) between bricks. + + The 'xgap' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xgap"] + + @xgap.setter + def xgap(self, val): + self["xgap"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def xtype(self): + """ + If "array", the heatmap's x coordinates are given by "x" (the + default behavior when `x` is provided). If "scaled", the + heatmap's x coordinates are given by "x0" and "dx" (the default + behavior when `x` is not provided). + + The 'xtype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self["xtype"] + + @xtype.setter + def xtype(self, val): + self["xtype"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def ygap(self): + """ + Sets the vertical gap (in pixels) between bricks. + + The 'ygap' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ygap"] + + @ygap.setter + def ygap(self, val): + self["ygap"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def ytype(self): + """ + If "array", the heatmap's y coordinates are given by "y" (the + default behavior when `y` is provided) If "scaled", the + heatmap's y coordinates are given by "y0" and "dy" (the default + behavior when `y` is not provided) + + The 'ytype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['array', 'scaled'] + + Returns + ------- + Any + """ + return self["ytype"] + + @ytype.setter + def ytype(self, val): + self["ytype"] = val + + @property + def z(self): + """ + Sets the z data. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def zsmooth(self): + """ + Picks a smoothing algorithm use to smooth `z` data. + + The 'zsmooth' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fast', 'best', False] + + Returns + ------- + Any + """ + return self["zsmooth"] + + @zsmooth.setter + def zsmooth(self, val): + self["zsmooth"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array and `zsmooth` + is not false; otherwise it is defaulted to false. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.heatmap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoverongaps=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textfont=None, + textsrc=None, + texttemplate=None, + transpose=None, + uid=None, + uirevision=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xgap=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + xtype=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + ygap=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + ytype=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zorder=None, + zsmooth=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Heatmap object + + The data that describes the heatmap value-to-color mapping is + set in `z`. Data in `z` can either be a 2D list of values + (ragged or not) or a 1D array of values. In the case where `z` + is a 2D list, say that `z` has N rows and M columns. Then, by + default, the resulting heatmap will have N partitions along the + y axis and M partitions along the x axis. In other words, the + i-th row/ j-th column cell in `z` is mapped to the i-th + partition of the y axis (starting from the bottom of the plot) + and the j-th partition of the x-axis (starting from the left of + the plot). This behavior can be flipped by using `transpose`. + Moreover, `x` (`y`) can be provided with M or M+1 (N or N+1) + elements. If M (N), then the coordinates correspond to the + center of the heatmap cells and the cells have equal width. If + M+1 (N+1), then the coordinates correspond to the edges of the + heatmap cells. In the case where `z` is a 1D list, the x and y + coordinates must be provided in `x` and `y` respectively to + form data triplets. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Heatmap` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.heatmap.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. It is defaulted + to true if `z` is a one dimensional array and `zsmooth` + is not false; otherwise it is defaulted to false. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.heatmap.Hoverlabel` + instance or dict with compatible properties + hoverongaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data have hover labels associated + with them. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.heatmap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.heatmap.Stream` instance + or dict with compatible properties + text + Sets the text elements associated with each z value. + textfont + Sets the text font. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + transpose + Transposes the z data. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + xtype + If "array", the heatmap's x coordinates are given by + "x" (the default behavior when `x` is provided). If + "scaled", the heatmap's x coordinates are given by "x0" + and "dx" (the default behavior when `x` is not + provided). + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + ytype + If "array", the heatmap's y coordinates are given by + "y" (the default behavior when `y` is provided) If + "scaled", the heatmap's y coordinates are given by "y0" + and "dy" (the default behavior when `y` is not + provided) + z + Sets the z data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Heatmap + """ + super().__init__("heatmap") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Heatmap +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Heatmap`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoverongaps", arg, hoverongaps) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("transpose", arg, transpose) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xgap", arg, xgap) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("xtype", arg, xtype) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("ygap", arg, ygap) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("ytype", arg, ytype) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zorder", arg, zorder) + self._set_property("zsmooth", arg, zsmooth) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "heatmap" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram.py new file mode 100644 index 0000000..9bc1462 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram.py @@ -0,0 +1,2419 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Histogram(_BaseTraceType): + _parent_path_str = "" + _path_str = "histogram" + _valid_props = { + "alignmentgroup", + "autobinx", + "autobiny", + "bingroup", + "cliponaxis", + "constraintext", + "cumulative", + "customdata", + "customdatasrc", + "error_x", + "error_y", + "histfunc", + "histnorm", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextanchor", + "insidetextfont", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "nbinsx", + "nbinsy", + "offsetgroup", + "opacity", + "orientation", + "outsidetextfont", + "selected", + "selectedpoints", + "showlegend", + "stream", + "text", + "textangle", + "textfont", + "textposition", + "textsrc", + "texttemplate", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "x", + "xaxis", + "xbins", + "xcalendar", + "xhoverformat", + "xsrc", + "y", + "yaxis", + "ybins", + "ycalendar", + "yhoverformat", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def autobinx(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobinx` is not needed. However, we accept + `autobinx: true` or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + + The 'autobinx' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autobinx"] + + @autobinx.setter + def autobinx(self, val): + self["autobinx"] = val + + @property + def autobiny(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobiny` is not needed. However, we accept + `autobiny: true` or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + + The 'autobiny' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autobiny"] + + @autobiny.setter + def autobiny(self, val): + self["autobiny"] = val + + @property + def bingroup(self): + """ + 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 `barmode` "stack", "relative" and + "group" are forced into the same bingroup, Using `bingroup`, + traces under `barmode` "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 `bingroup` + + The 'bingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["bingroup"] + + @bingroup.setter + def bingroup(self, val): + self["bingroup"] = val + + @property + def cliponaxis(self): + """ + Determines whether the text nodes are clipped about the subplot + axes. To show the text nodes above axis lines and tick labels, + make sure to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def constraintext(self): + """ + Constrain the size of text inside or outside a bar to be no + larger than the bar itself. + + The 'constraintext' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'both', 'none'] + + Returns + ------- + Any + """ + return self["constraintext"] + + @constraintext.setter + def constraintext(self, val): + self["constraintext"] = val + + @property + def cumulative(self): + """ + The 'cumulative' property is an instance of Cumulative + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Cumulative` + - A dict of string/value properties that will be passed + to the Cumulative constructor + + Returns + ------- + plotly.graph_objs.histogram.Cumulative + """ + return self["cumulative"] + + @cumulative.setter + def cumulative(self, val): + self["cumulative"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.ErrorX` + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Returns + ------- + plotly.graph_objs.histogram.ErrorX + """ + return self["error_x"] + + @error_x.setter + def error_x(self, val): + self["error_x"] = val + + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.ErrorY` + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Returns + ------- + plotly.graph_objs.histogram.ErrorY + """ + return self["error_y"] + + @error_y.setter + def error_y(self, val): + self["error_y"] = val + + @property + def histfunc(self): + """ + 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. + + The 'histfunc' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['count', 'sum', 'avg', 'min', 'max'] + + Returns + ------- + Any + """ + return self["histfunc"] + + @histfunc.setter + def histfunc(self, val): + self["histfunc"] = val + + @property + def histnorm(self): + """ + 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). + + The 'histnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'percent', 'probability', 'density', 'probability + density'] + + Returns + ------- + Any + """ + return self["histnorm"] + + @histnorm.setter + def histnorm(self, val): + self["histnorm"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.histogram.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variable `binNumber` Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextanchor(self): + """ + Determines if texts are kept at center or start/end points in + `textposition` "inside" mode. + + The 'insidetextanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['end', 'middle', 'start'] + + Returns + ------- + Any + """ + return self["insidetextanchor"] + + @insidetextanchor.setter + def insidetextanchor(self, val): + self["insidetextanchor"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `text` lying inside the bar. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.histogram.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.histogram.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.histogram.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def nbinsx(self): + """ + 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 `xbins.size` is provided. + + The 'nbinsx' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nbinsx"] + + @nbinsx.setter + def nbinsx(self, val): + self["nbinsx"] = val + + @property + def nbinsy(self): + """ + 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 `ybins.size` is provided. + + The 'nbinsy' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nbinsy"] + + @nbinsy.setter + def nbinsy(self, val): + self["nbinsy"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Sets the orientation of the bars. With "v" ("h"), the value of + the each bar spans along the vertical (horizontal). + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `text` lying outside the bar. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.histogram.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.histogram.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.histogram.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + 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. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle of the tick labels with respect to the bar. For + example, a `tickangle` of -90 draws the tick labels vertically. + With "auto" the texts may automatically be rotated to fit with + the maximum size in bars. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.histogram.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Specifies the location of the `text`. "inside" positions `text` + inside, next to the bar end (rotated and scaled if needed). + "outside" positions `text` outside, next to the bar end (scaled + if needed), unless there is another bar stacked on this one, + then the text gets pushed inside. "auto" tries to position + `text` inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If "none", no + text appears. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'auto', 'none'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `label` + and `value`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.histogram.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the sample data to be binned on the x axis. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xbins(self): + """ + The 'xbins' property is an instance of XBins + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.XBins` + - A dict of string/value properties that will be passed + to the XBins constructor + + Returns + ------- + plotly.graph_objs.histogram.XBins + """ + return self["xbins"] + + @xbins.setter + def xbins(self, val): + self["xbins"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the sample data to be binned on the y axis. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ybins(self): + """ + The 'ybins' property is an instance of YBins + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.YBins` + - A dict of string/value properties that will be passed + to the YBins constructor + + Returns + ------- + plotly.graph_objs.histogram.YBins + """ + return self["ybins"] + + @ybins.setter + def ybins(self, val): + self["ybins"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + 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 `barmode` + "stack", "relative" and "group" are forced into the + same bingroup, Using `bingroup`, traces under `barmode` + "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 `bingroup` + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + cumulative + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `binNumber` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties + 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. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the text font. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label` and `value`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + autobinx=None, + autobiny=None, + bingroup=None, + cliponaxis=None, + constraintext=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, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + offsetgroup=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + xaxis=None, + xbins=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybins=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Histogram object + + The sample data from which statistics are computed is set in + `x` for vertically spanning histograms and in `y` for + horizontally spanning histograms. Binning options are set + `xbins` and `ybins` respectively if no aggregation data is + provided. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Histogram` + 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. + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + 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 `barmode` + "stack", "relative" and "group" are forced into the + same bingroup, Using `bingroup`, traces under `barmode` + "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 `bingroup` + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + cumulative + :class:`plotly.graph_objects.histogram.Cumulative` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.histogram.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.histogram.ErrorY` instance + or dict with compatible properties + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `binNumber` Anything contained in tag + `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + selected + :class:`plotly.graph_objects.histogram.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.histogram.Stream` instance + or dict with compatible properties + 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. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the text font. + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label` and `value`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.histogram.Unselected` + instance or dict with compatible properties + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbins + :class:`plotly.graph_objects.histogram.XBins` instance + or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybins + :class:`plotly.graph_objects.histogram.YBins` instance + or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Histogram + """ + super().__init__("histogram") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Histogram +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Histogram`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("autobinx", arg, autobinx) + self._set_property("autobiny", arg, autobiny) + self._set_property("bingroup", arg, bingroup) + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("constraintext", arg, constraintext) + self._set_property("cumulative", arg, cumulative) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("error_x", arg, error_x) + self._set_property("error_y", arg, error_y) + self._set_property("histfunc", arg, histfunc) + self._set_property("histnorm", arg, histnorm) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextanchor", arg, insidetextanchor) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("nbinsx", arg, nbinsx) + self._set_property("nbinsy", arg, nbinsy) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xaxis", arg, xaxis) + self._set_property("xbins", arg, xbins) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yaxis", arg, yaxis) + self._set_property("ybins", arg, ybins) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "histogram" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2d.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2d.py new file mode 100644 index 0000000..bf1befd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2d.py @@ -0,0 +1,2363 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Histogram2d(_BaseTraceType): + _parent_path_str = "" + _path_str = "histogram2d" + _valid_props = { + "autobinx", + "autobiny", + "autocolorscale", + "bingroup", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "histfunc", + "histnorm", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "nbinsx", + "nbinsy", + "opacity", + "reversescale", + "showlegend", + "showscale", + "stream", + "textfont", + "texttemplate", + "type", + "uid", + "uirevision", + "visible", + "x", + "xaxis", + "xbingroup", + "xbins", + "xcalendar", + "xgap", + "xhoverformat", + "xsrc", + "y", + "yaxis", + "ybingroup", + "ybins", + "ycalendar", + "ygap", + "yhoverformat", + "ysrc", + "z", + "zauto", + "zhoverformat", + "zmax", + "zmid", + "zmin", + "zsmooth", + "zsrc", + } + + @property + def autobinx(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobinx` is not needed. However, we accept + `autobinx: true` or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + + The 'autobinx' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autobinx"] + + @autobinx.setter + def autobinx(self, val): + self["autobinx"] = val + + @property + def autobiny(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobiny` is not needed. However, we accept + `autobiny: true` or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + + The 'autobiny' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autobiny"] + + @autobiny.setter + def autobiny(self, val): + self["autobiny"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def bingroup(self): + """ + Set the `xbingroup` and `ybingroup` default prefix For example, + setting a `bingroup` of 1 on two histogram2d traces will make + them their x-bins and y-bins match separately. + + The 'bingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["bingroup"] + + @bingroup.setter + def bingroup(self, val): + self["bingroup"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.histogram2d.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def histfunc(self): + """ + 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. + + The 'histfunc' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['count', 'sum', 'avg', 'min', 'max'] + + Returns + ------- + Any + """ + return self["histfunc"] + + @histfunc.setter + def histfunc(self, val): + self["histfunc"] = val + + @property + def histnorm(self): + """ + 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). + + The 'histnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'percent', 'probability', 'density', 'probability + density'] + + Returns + ------- + Any + """ + return self["histnorm"] + + @histnorm.setter + def histnorm(self, val): + self["histnorm"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.histogram2d.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variable `z` Anything contained + in tag `` is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.histogram2d.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.histogram2d.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def nbinsx(self): + """ + 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 `xbins.size` is provided. + + The 'nbinsx' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nbinsx"] + + @nbinsx.setter + def nbinsx(self, val): + self["nbinsx"] = val + + @property + def nbinsy(self): + """ + 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 `ybins.size` is provided. + + The 'nbinsy' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nbinsy"] + + @nbinsy.setter + def nbinsy(self, val): + self["nbinsy"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.histogram2d.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.histogram2d.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variable `z` + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the sample data to be binned on the x axis. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xbingroup(self): + """ + Set a group of histogram traces which will have compatible + x-bin settings. Using `xbingroup`, histogram2d and + histogram2dcontour traces (on axes of the same axis type) can + have compatible x-bin settings. Note that the same `xbingroup` + value can be used to set (1D) histogram `bingroup` + + The 'xbingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xbingroup"] + + @xbingroup.setter + def xbingroup(self, val): + self["xbingroup"] = val + + @property + def xbins(self): + """ + The 'xbins' property is an instance of XBins + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.XBins` + - A dict of string/value properties that will be passed + to the XBins constructor + + Returns + ------- + plotly.graph_objs.histogram2d.XBins + """ + return self["xbins"] + + @xbins.setter + def xbins(self, val): + self["xbins"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xgap(self): + """ + Sets the horizontal gap (in pixels) between bricks. + + The 'xgap' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xgap"] + + @xgap.setter + def xgap(self, val): + self["xgap"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the sample data to be binned on the y axis. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ybingroup(self): + """ + Set a group of histogram traces which will have compatible + y-bin settings. Using `ybingroup`, histogram2d and + histogram2dcontour traces (on axes of the same axis type) can + have compatible y-bin settings. Note that the same `ybingroup` + value can be used to set (1D) histogram `bingroup` + + The 'ybingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ybingroup"] + + @ybingroup.setter + def ybingroup(self, val): + self["ybingroup"] = val + + @property + def ybins(self): + """ + The 'ybins' property is an instance of YBins + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.YBins` + - A dict of string/value properties that will be passed + to the YBins constructor + + Returns + ------- + plotly.graph_objs.histogram2d.YBins + """ + return self["ybins"] + + @ybins.setter + def ybins(self, val): + self["ybins"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def ygap(self): + """ + Sets the vertical gap (in pixels) between bricks. + + The 'ygap' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ygap"] + + @ygap.setter + def ygap(self, val): + self["ygap"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the aggregation data. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsmooth(self): + """ + Picks a smoothing algorithm use to smooth `z` data. + + The 'zsmooth' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fast', 'best', False] + + Returns + ------- + Any + """ + return self["zsmooth"] + + @zsmooth.setter + def zsmooth(self, val): + self["zsmooth"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2d.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties + textfont + Sets the text font. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autobinx=None, + autobiny=None, + autocolorscale=None, + bingroup=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + textfont=None, + texttemplate=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbingroup=None, + xbins=None, + xcalendar=None, + xgap=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybingroup=None, + ybins=None, + ycalendar=None, + ygap=None, + yhoverformat=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsmooth=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Histogram2d object + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a heatmap. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Histogram2d` + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2d.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2d.Legendgrouptit + le` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.histogram2d.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2d.Stream` + instance or dict with compatible properties + textfont + Sets the text font. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2d.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xgap + Sets the horizontal gap (in pixels) between bricks. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2d.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + ygap + Sets the vertical gap (in pixels) between bricks. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsmooth + Picks a smoothing algorithm use to smooth `z` data. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Histogram2d + """ + super().__init__("histogram2d") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Histogram2d +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Histogram2d`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autobinx", arg, autobinx) + self._set_property("autobiny", arg, autobiny) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("bingroup", arg, bingroup) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("histfunc", arg, histfunc) + self._set_property("histnorm", arg, histnorm) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("nbinsx", arg, nbinsx) + self._set_property("nbinsy", arg, nbinsy) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("textfont", arg, textfont) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xaxis", arg, xaxis) + self._set_property("xbingroup", arg, xbingroup) + self._set_property("xbins", arg, xbins) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xgap", arg, xgap) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yaxis", arg, yaxis) + self._set_property("ybingroup", arg, ybingroup) + self._set_property("ybins", arg, ybins) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("ygap", arg, ygap) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsmooth", arg, zsmooth) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "histogram2d" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2dcontour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2dcontour.py new file mode 100644 index 0000000..2cfc1ed --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_histogram2dcontour.py @@ -0,0 +1,2422 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Histogram2dContour(_BaseTraceType): + _parent_path_str = "" + _path_str = "histogram2dcontour" + _valid_props = { + "autobinx", + "autobiny", + "autocolorscale", + "autocontour", + "bingroup", + "coloraxis", + "colorbar", + "colorscale", + "contours", + "customdata", + "customdatasrc", + "histfunc", + "histnorm", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "name", + "nbinsx", + "nbinsy", + "ncontours", + "opacity", + "reversescale", + "showlegend", + "showscale", + "stream", + "textfont", + "texttemplate", + "type", + "uid", + "uirevision", + "visible", + "x", + "xaxis", + "xbingroup", + "xbins", + "xcalendar", + "xhoverformat", + "xsrc", + "y", + "yaxis", + "ybingroup", + "ybins", + "ycalendar", + "yhoverformat", + "ysrc", + "z", + "zauto", + "zhoverformat", + "zmax", + "zmid", + "zmin", + "zsrc", + } + + @property + def autobinx(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobinx` is not needed. However, we accept + `autobinx: true` or `false` and will update `xbins` accordingly + before deleting `autobinx` from the trace. + + The 'autobinx' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autobinx"] + + @autobinx.setter + def autobinx(self, val): + self["autobinx"] = val + + @property + def autobiny(self): + """ + Obsolete: since v1.42 each bin attribute is auto-determined + separately and `autobiny` is not needed. However, we accept + `autobiny: true` or `false` and will update `ybins` accordingly + before deleting `autobiny` from the trace. + + The 'autobiny' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autobiny"] + + @autobiny.setter + def autobiny(self, val): + self["autobiny"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def autocontour(self): + """ + Determines whether or not the contour level attributes are + picked by an algorithm. If True, the number of contour levels + can be set in `ncontours`. If False, set the contour level + attributes in `contours`. + + The 'autocontour' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocontour"] + + @autocontour.setter + def autocontour(self, val): + self["autocontour"] = val + + @property + def bingroup(self): + """ + Set the `xbingroup` and `ybingroup` default prefix For example, + setting a `bingroup` of 1 on two histogram2d traces will make + them their x-bins and y-bins match separately. + + The 'bingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["bingroup"] + + @bingroup.setter + def bingroup(self, val): + self["bingroup"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Contours` + - A dict of string/value properties that will be passed + to the Contours constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Contours + """ + return self["contours"] + + @contours.setter + def contours(self, val): + self["contours"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def histfunc(self): + """ + 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. + + The 'histfunc' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['count', 'sum', 'avg', 'min', 'max'] + + Returns + ------- + Any + """ + return self["histfunc"] + + @histfunc.setter + def histfunc(self, val): + self["histfunc"] = val + + @property + def histnorm(self): + """ + 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). + + The 'histnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'percent', 'probability', 'density', 'probability + density'] + + Returns + ------- + Any + """ + return self["histnorm"] + + @histnorm.setter + def histnorm(self, val): + self["histnorm"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variable `z` Anything contained + in tag `` is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def nbinsx(self): + """ + 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 `xbins.size` is provided. + + The 'nbinsx' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nbinsx"] + + @nbinsx.setter + def nbinsx(self, val): + self["nbinsx"] = val + + @property + def nbinsy(self): + """ + 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 `ybins.size` is provided. + + The 'nbinsy' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nbinsy"] + + @nbinsy.setter + def nbinsy(self, val): + self["nbinsy"] = val + + @property + def ncontours(self): + """ + Sets the maximum number of contour levels. The actual number of + contours will be chosen automatically to be less than or equal + to the value of `ncontours`. Has an effect only if + `autocontour` is True or if `contours.size` is missing. + + The 'ncontours' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ncontours"] + + @ncontours.setter + def ncontours(self, val): + self["ncontours"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `zmin` will + correspond to the last color in the array and `zmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def textfont(self): + """ + For this trace it only has an effect if `coloring` is set to + "heatmap". Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def texttemplate(self): + """ + For this trace it only has an effect if `coloring` is set to + "heatmap". Template string used for rendering the information + text that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `x`, `y`, + `z` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the sample data to be binned on the x axis. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xbingroup(self): + """ + Set a group of histogram traces which will have compatible + x-bin settings. Using `xbingroup`, histogram2d and + histogram2dcontour traces (on axes of the same axis type) can + have compatible x-bin settings. Note that the same `xbingroup` + value can be used to set (1D) histogram `bingroup` + + The 'xbingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xbingroup"] + + @xbingroup.setter + def xbingroup(self, val): + self["xbingroup"] = val + + @property + def xbins(self): + """ + The 'xbins' property is an instance of XBins + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.XBins` + - A dict of string/value properties that will be passed + to the XBins constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.XBins + """ + return self["xbins"] + + @xbins.setter + def xbins(self, val): + self["xbins"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the sample data to be binned on the y axis. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ybingroup(self): + """ + Set a group of histogram traces which will have compatible + y-bin settings. Using `ybingroup`, histogram2d and + histogram2dcontour traces (on axes of the same axis type) can + have compatible y-bin settings. Note that the same `ybingroup` + value can be used to set (1D) histogram `bingroup` + + The 'ybingroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ybingroup"] + + @ybingroup.setter + def ybingroup(self, val): + self["ybingroup"] = val + + @property + def ybins(self): + """ + The 'ybins' property is an instance of YBins + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.YBins` + - A dict of string/value properties that will be passed + to the YBins constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.YBins + """ + return self["ybins"] + + @ybins.setter + def ybins(self, val): + self["ybins"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the aggregation data. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `z`) or the bounds set in + `zmin` and `zmax` Defaults to `false` when `zmin` and `zmax` + are set by the user. + + The 'zauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zauto"] + + @zauto.setter + def zauto(self, val): + self["zauto"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as in `z` and if set, `zmin` must be set as well. + + The 'zmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmid(self): + """ + Sets the mid-point of the color domain by scaling `zmin` and/or + `zmax` to be equidistant to this point. Value should have the + same units as in `z`. Has no effect when `zauto` is `false`. + + The 'zmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmid"] + + @zmid.setter + def zmid(self, val): + self["zmid"] = val + + @property + def zmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as in `z` and if set, `zmax` must be set as well. + + The 'zmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2dcontour.Legendg + rouptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autobinx=None, + autobiny=None, + autocolorscale=None, + autocontour=None, + bingroup=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contours=None, + customdata=None, + customdatasrc=None, + histfunc=None, + histnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + name=None, + nbinsx=None, + nbinsy=None, + ncontours=None, + opacity=None, + reversescale=None, + showlegend=None, + showscale=None, + stream=None, + textfont=None, + texttemplate=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xbingroup=None, + xbins=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + yaxis=None, + ybingroup=None, + ybins=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zauto=None, + zhoverformat=None, + zmax=None, + zmid=None, + zmin=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Histogram2dContour object + + The sample data from which statistics are computed is set in + `x` and `y` (where `x` and `y` represent marginal + distributions, binning is set in `xbins` and `ybins` in this + case) or `z` (where `z` represent the 2D distribution and + binning set, binning is set by `x` and `y` in this case). The + resulting distribution is visualized as a contour plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.Histogram2dContour` + autobinx + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobinx` is not needed. + However, we accept `autobinx: true` or `false` and will + update `xbins` accordingly before deleting `autobinx` + from the trace. + autobiny + Obsolete: since v1.42 each bin attribute is auto- + determined separately and `autobiny` is not needed. + However, we accept `autobiny: true` or `false` and will + update `ybins` accordingly before deleting `autobiny` + from the trace. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + autocontour + Determines whether or not the contour level attributes + are picked by an algorithm. If True, the number of + contour levels can be set in `ncontours`. If False, set + the contour level attributes in `contours`. + bingroup + Set the `xbingroup` and `ybingroup` default prefix For + example, setting a `bingroup` of 1 on two histogram2d + traces will make them their x-bins and y-bins match + separately. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram2dcontour.ColorBa + r` instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `zmin` and `zmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contours + :class:`plotly.graph_objects.histogram2dcontour.Contour + s` instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + 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. + 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). + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.histogram2dcontour.Hoverla + bel` instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variable `z` Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.histogram2dcontour.Legendg + rouptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.histogram2dcontour.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.histogram2dcontour.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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 + `xbins.size` is provided. + 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 + `ybins.size` is provided. + ncontours + Sets the maximum number of contour levels. The actual + number of contours will be chosen automatically to be + less than or equal to the value of `ncontours`. Has an + effect only if `autocontour` is True or if + `contours.size` is missing. + opacity + Sets the opacity of the trace. + reversescale + Reverses the color mapping if true. If true, `zmin` + will correspond to the last color in the array and + `zmax` will correspond to the first color. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.histogram2dcontour.Stream` + instance or dict with compatible properties + textfont + For this trace it only has an effect if `coloring` is + set to "heatmap". Sets the text font. + texttemplate + For this trace it only has an effect if `coloring` is + set to "heatmap". Template string used for rendering + the information text that appear on points. Note that + this will override `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `x`, `y`, `z` and `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the sample data to be binned on the x axis. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xbingroup + Set a group of histogram traces which will have + compatible x-bin settings. Using `xbingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible x-bin settings. + Note that the same `xbingroup` value can be used to set + (1D) histogram `bingroup` + xbins + :class:`plotly.graph_objects.histogram2dcontour.XBins` + instance or dict with compatible properties + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the sample data to be binned on the y axis. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ybingroup + Set a group of histogram traces which will have + compatible y-bin settings. Using `ybingroup`, + histogram2d and histogram2dcontour traces (on axes of + the same axis type) can have compatible y-bin settings. + Note that the same `ybingroup` value can be used to set + (1D) histogram `bingroup` + ybins + :class:`plotly.graph_objects.histogram2dcontour.YBins` + instance or dict with compatible properties + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the aggregation data. + zauto + Determines whether or not the color domain is computed + with respect to the input data (here in `z`) or the + bounds set in `zmin` and `zmax` Defaults to `false` + when `zmin` and `zmax` are set by the user. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + zmax + Sets the upper bound of the color domain. Value should + have the same units as in `z` and if set, `zmin` must + be set as well. + zmid + Sets the mid-point of the color domain by scaling + `zmin` and/or `zmax` to be equidistant to this point. + Value should have the same units as in `z`. Has no + effect when `zauto` is `false`. + zmin + Sets the lower bound of the color domain. Value should + have the same units as in `z` and if set, `zmax` must + be set as well. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Histogram2dContour + """ + super().__init__("histogram2dcontour") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Histogram2dContour +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Histogram2dContour`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autobinx", arg, autobinx) + self._set_property("autobiny", arg, autobiny) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("autocontour", arg, autocontour) + self._set_property("bingroup", arg, bingroup) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("contours", arg, contours) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("histfunc", arg, histfunc) + self._set_property("histnorm", arg, histnorm) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("nbinsx", arg, nbinsx) + self._set_property("nbinsy", arg, nbinsy) + self._set_property("ncontours", arg, ncontours) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("textfont", arg, textfont) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xaxis", arg, xaxis) + self._set_property("xbingroup", arg, xbingroup) + self._set_property("xbins", arg, xbins) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yaxis", arg, yaxis) + self._set_property("ybingroup", arg, ybingroup) + self._set_property("ybins", arg, ybins) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zauto", arg, zauto) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zmax", arg, zmax) + self._set_property("zmid", arg, zmid) + self._set_property("zmin", arg, zmin) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "histogram2dcontour" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_icicle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_icicle.py new file mode 100644 index 0000000..94d4919 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_icicle.py @@ -0,0 +1,1765 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Icicle(_BaseTraceType): + _parent_path_str = "" + _path_str = "icicle" + _valid_props = { + "branchvalues", + "count", + "customdata", + "customdatasrc", + "domain", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextfont", + "labels", + "labelssrc", + "leaf", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "level", + "marker", + "maxdepth", + "meta", + "metasrc", + "name", + "opacity", + "outsidetextfont", + "parents", + "parentssrc", + "pathbar", + "root", + "sort", + "stream", + "text", + "textfont", + "textinfo", + "textposition", + "textsrc", + "texttemplate", + "texttemplatesrc", + "tiling", + "type", + "uid", + "uirevision", + "values", + "valuessrc", + "visible", + } + + @property + def branchvalues(self): + """ + Determines how the items in `values` are summed. When set to + "total", items in `values` are taken to be value of all its + descendants. 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. + + The 'branchvalues' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['remainder', 'total'] + + Returns + ------- + Any + """ + return self["branchvalues"] + + @branchvalues.setter + def branchvalues(self, val): + self["branchvalues"] = val + + @property + def count(self): + """ + Determines default for `values` when it is not provided, by + inferring a 1 for each of the "leaves" and/or "branches", + otherwise 0. + + The 'count' property is a flaglist and may be specified + as a string containing: + - Any combination of ['branches', 'leaves'] joined with '+' characters + (e.g. 'branches+leaves') + + Returns + ------- + Any + """ + return self["count"] + + @count.setter + def count(self, val): + self["count"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.icicle.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.icicle.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `currentPath`, `root`, + `entry`, `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each sector. If a + single string, the same string appears for all data points. If + an array of string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` must contain a + "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `textinfo` lying inside the sector. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.icicle.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def labels(self): + """ + Sets the labels of each of the sectors. + + The 'labels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["labels"] + + @labels.setter + def labels(self, val): + self["labels"] = val + + @property + def labelssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `labels`. + + The 'labelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelssrc"] + + @labelssrc.setter + def labelssrc(self, val): + self["labelssrc"] = val + + @property + def leaf(self): + """ + The 'leaf' property is an instance of Leaf + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Leaf` + - A dict of string/value properties that will be passed + to the Leaf constructor + + Returns + ------- + plotly.graph_objs.icicle.Leaf + """ + return self["leaf"] + + @leaf.setter + def leaf(self, val): + self["leaf"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.icicle.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def level(self): + """ + Sets the level from which this trace hierarchy is rendered. Set + `level` to `''` to start from the root node in the hierarchy. + Must be an "id" if `ids` is filled in, otherwise plotly + attempts to find a matching item in `labels`. + + The 'level' property accepts values of any type + + Returns + ------- + Any + """ + return self["level"] + + @level.setter + def level(self, val): + self["level"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.icicle.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def maxdepth(self): + """ + Sets the number of rendered sectors from any given `level`. Set + `maxdepth` to "-1" to render all the levels in the hierarchy. + + The 'maxdepth' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["maxdepth"] + + @maxdepth.setter + def maxdepth(self, val): + self["maxdepth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `textinfo` lying outside the sector. + This option refers to the root of the hierarchy presented on + top left corner of a treemap graph. Please note that if a + hierarchy has multiple root nodes, this option won't have any + effect and `insidetextfont` would be used. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.icicle.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def parents(self): + """ + Sets the parent sectors for each of the sectors. Empty string + items '' are understood to reference the root node in the + hierarchy. If `ids` is filled, `parents` items are understood + to be "ids" themselves. When `ids` is not set, plotly attempts + to find matching items in `labels`, but beware they must be + unique. + + The 'parents' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["parents"] + + @parents.setter + def parents(self, val): + self["parents"] = val + + @property + def parentssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `parents`. + + The 'parentssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["parentssrc"] + + @parentssrc.setter + def parentssrc(self, val): + self["parentssrc"] = val + + @property + def pathbar(self): + """ + The 'pathbar' property is an instance of Pathbar + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Pathbar` + - A dict of string/value properties that will be passed + to the Pathbar constructor + + Returns + ------- + plotly.graph_objs.icicle.Pathbar + """ + return self["pathbar"] + + @pathbar.setter + def pathbar(self, val): + self["pathbar"] = val + + @property + def root(self): + """ + The 'root' property is an instance of Root + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Root` + - A dict of string/value properties that will be passed + to the Root constructor + + Returns + ------- + plotly.graph_objs.icicle.Root + """ + return self["root"] + + @root.setter + def root(self, val): + self["root"] = val + + @property + def sort(self): + """ + Determines whether or not the sectors are reordered from + largest to smallest. + + The 'sort' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["sort"] + + @sort.setter + def sort(self, val): + self["sort"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.icicle.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each sector. If trace + `textinfo` contains a "text" flag, these elements will be seen + on the chart. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the font used for `textinfo`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.icicle.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables + `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, + `percentParent`, `label` and `value`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def tiling(self): + """ + The 'tiling' property is an instance of Tiling + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.Tiling` + - A dict of string/value properties that will be passed + to the Tiling constructor + + Returns + ------- + plotly.graph_objs.icicle.Tiling + """ + return self["tiling"] + + @tiling.setter + def tiling(self, val): + self["tiling"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def values(self): + """ + Sets the values associated with each of the sectors. Use with + `branchvalues` to determine how the values are summed. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.icicle.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.icicle.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.icicle.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.icicle.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.icicle.Marker` instance or + dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.icicle.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.icicle.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.icicle.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.icicle.Tiling` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + """ + + def __init__( + self, + arg=None, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + labels=None, + labelssrc=None, + leaf=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + pathbar=None, + root=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + tiling=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Icicle object + + Visualize hierarchal data from leaves (and/or outer branches) + towards root with rectangles. The icicle sectors are determined + by the entries in "labels" or "ids" and in "parents". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Icicle` + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.icicle.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.icicle.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.icicle.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.icicle.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.icicle.Marker` instance or + dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.icicle.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.icicle.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.icicle.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.icicle.Tiling` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + + Returns + ------- + Icicle + """ + super().__init__("icicle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Icicle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Icicle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("branchvalues", arg, branchvalues) + self._set_property("count", arg, count) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("domain", arg, domain) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("labels", arg, labels) + self._set_property("labelssrc", arg, labelssrc) + self._set_property("leaf", arg, leaf) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("level", arg, level) + self._set_property("marker", arg, marker) + self._set_property("maxdepth", arg, maxdepth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("parents", arg, parents) + self._set_property("parentssrc", arg, parentssrc) + self._set_property("pathbar", arg, pathbar) + self._set_property("root", arg, root) + self._set_property("sort", arg, sort) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textposition", arg, textposition) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("tiling", arg, tiling) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + + self._props["type"] = "icicle" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_image.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_image.py new file mode 100644 index 0000000..e0f8afe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_image.py @@ -0,0 +1,1454 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Image(_BaseTraceType): + _parent_path_str = "" + _path_str = "image" + _valid_props = { + "colormodel", + "customdata", + "customdatasrc", + "dx", + "dy", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "meta", + "metasrc", + "name", + "opacity", + "source", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "visible", + "x0", + "xaxis", + "y0", + "yaxis", + "z", + "zmax", + "zmin", + "zorder", + "zsmooth", + "zsrc", + } + + @property + def colormodel(self): + """ + Color model used to map the numerical color components + described in `z` into colors. If `source` is specified, this + attribute will be set to `rgba256` otherwise it defaults to + `rgb`. + + The 'colormodel' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['rgb', 'rgba', 'rgba256', 'hsl', 'hsla'] + + Returns + ------- + Any + """ + return self["colormodel"] + + @colormodel.setter + def colormodel(self, val): + self["colormodel"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Set the pixel's horizontal size. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Set the pixel's vertical size + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'color', 'name', 'text'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.image.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.image.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `z`, `color` and + `colormodel`. Anything contained in tag `` is displayed + in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.image.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.image.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def source(self): + """ + Specifies the data URI of the image to be visualized. The URI + consists of "data:image/[][;base64]," + + The 'source' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["source"] + + @source.setter + def source(self, val): + self["source"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.image.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.image.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each z value. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x0(self): + """ + Set the image's x position. The left edge of the image (or the + right edge if the x axis is reversed or dx is negative) will be + found at xmin=x0-dx/2 + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def y0(self): + """ + Set the image's y position. The top edge of the image (or the + bottom edge if the y axis is NOT reversed or if dy is negative) + will be found at ymin=y0-dy/2. By default when an image trace + is included, the y axis will be reversed so that the image is + right-side-up, but you can disable this by setting + yaxis.autorange=true or by providing an explicit y axis range. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def z(self): + """ + A 2-dimensional array in which each element is an array of 3 or + 4 numbers representing a color. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zmax(self): + """ + Array defining the higher bound for each color component. Note + that the default value will depend on the colormodel. For the + `rgb` colormodel, it is [255, 255, 255]. For the `rgba` + colormodel, it is [255, 255, 255, 1]. For the `rgba256` + colormodel, it is [255, 255, 255, 255]. For the `hsl` + colormodel, it is [360, 100, 100]. For the `hsla` colormodel, + it is [360, 100, 100, 1]. + + The 'zmax' property is an info array that may be specified as: + + * a list or tuple of 4 elements where: + (0) The 'zmax[0]' property is a number and may be specified as: + - An int or float + (1) The 'zmax[1]' property is a number and may be specified as: + - An int or float + (2) The 'zmax[2]' property is a number and may be specified as: + - An int or float + (3) The 'zmax[3]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["zmax"] + + @zmax.setter + def zmax(self, val): + self["zmax"] = val + + @property + def zmin(self): + """ + Array defining the lower bound for each color component. Note + that the default value will depend on the colormodel. For the + `rgb` colormodel, it is [0, 0, 0]. For the `rgba` colormodel, + it is [0, 0, 0, 0]. For the `rgba256` colormodel, it is [0, 0, + 0, 0]. For the `hsl` colormodel, it is [0, 0, 0]. For the + `hsla` colormodel, it is [0, 0, 0, 0]. + + The 'zmin' property is an info array that may be specified as: + + * a list or tuple of 4 elements where: + (0) The 'zmin[0]' property is a number and may be specified as: + - An int or float + (1) The 'zmin[1]' property is a number and may be specified as: + - An int or float + (2) The 'zmin[2]' property is a number and may be specified as: + - An int or float + (3) The 'zmin[3]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["zmin"] + + @zmin.setter + def zmin(self, val): + self["zmin"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def zsmooth(self): + """ + Picks a smoothing algorithm used to smooth `z` data. This only + applies for image traces that use the `source` attribute. + + The 'zsmooth' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fast', False] + + Returns + ------- + Any + """ + return self["zsmooth"] + + @zsmooth.setter + def zsmooth(self, val): + self["zsmooth"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + colormodel + Color model used to map the numerical color components + described in `z` into colors. If `source` is specified, + this attribute will be set to `rgba256` otherwise it + defaults to `rgb`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Set the pixel's horizontal size. + dy + Set the pixel's vertical size + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `z`, `color` and `colormodel`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.image.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + source + Specifies the data URI of the image to be visualized. + The URI consists of "data:image/[][;base64]," + stream + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x0 + Set the image's x position. The left edge of the image + (or the right edge if the x axis is reversed or dx is + negative) will be found at xmin=x0-dx/2 + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + y0 + Set the image's y position. The top edge of the image + (or the bottom edge if the y axis is NOT reversed or if + dy is negative) will be found at ymin=y0-dy/2. By + default when an image trace is included, the y axis + will be reversed so that the image is right-side-up, + but you can disable this by setting + yaxis.autorange=true or by providing an explicit y axis + range. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + A 2-dimensional array in which each element is an array + of 3 or 4 numbers representing a color. + zmax + Array defining the higher bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [255, + 255, 255]. For the `rgba` colormodel, it is [255, 255, + 255, 1]. For the `rgba256` colormodel, it is [255, 255, + 255, 255]. For the `hsl` colormodel, it is [360, 100, + 100]. For the `hsla` colormodel, it is [360, 100, 100, + 1]. + zmin + Array defining the lower bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [0, 0, + 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For + the `rgba256` colormodel, it is [0, 0, 0, 0]. For the + `hsl` colormodel, it is [0, 0, 0]. For the `hsla` + colormodel, it is [0, 0, 0, 0]. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm used to smooth `z` data. + This only applies for image traces that use the + `source` attribute. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + colormodel=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + source=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x0=None, + xaxis=None, + y0=None, + yaxis=None, + z=None, + zmax=None, + zmin=None, + zorder=None, + zsmooth=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Image object + + Display an image, i.e. data on a 2D regular raster. By default, + when an image is displayed in a subplot, its y axis will be + reversed (ie. `autorange: 'reversed'`), constrained to the + domain (ie. `constrain: 'domain'`) and it will have the same + scale as its x axis (ie. `scaleanchor: 'x,`) in order for + pixels to be rendered as squares. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Image` + colormodel + Color model used to map the numerical color components + described in `z` into colors. If `source` is specified, + this attribute will be set to `rgba256` otherwise it + defaults to `rgb`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Set the pixel's horizontal size. + dy + Set the pixel's vertical size + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.image.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `z`, `color` and `colormodel`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.image.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + source + Specifies the data URI of the image to be visualized. + The URI consists of "data:image/[][;base64]," + stream + :class:`plotly.graph_objects.image.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each z value. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x0 + Set the image's x position. The left edge of the image + (or the right edge if the x axis is reversed or dx is + negative) will be found at xmin=x0-dx/2 + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + y0 + Set the image's y position. The top edge of the image + (or the bottom edge if the y axis is NOT reversed or if + dy is negative) will be found at ymin=y0-dy/2. By + default when an image trace is included, the y axis + will be reversed so that the image is right-side-up, + but you can disable this by setting + yaxis.autorange=true or by providing an explicit y axis + range. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + z + A 2-dimensional array in which each element is an array + of 3 or 4 numbers representing a color. + zmax + Array defining the higher bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [255, + 255, 255]. For the `rgba` colormodel, it is [255, 255, + 255, 1]. For the `rgba256` colormodel, it is [255, 255, + 255, 255]. For the `hsl` colormodel, it is [360, 100, + 100]. For the `hsla` colormodel, it is [360, 100, 100, + 1]. + zmin + Array defining the lower bound for each color + component. Note that the default value will depend on + the colormodel. For the `rgb` colormodel, it is [0, 0, + 0]. For the `rgba` colormodel, it is [0, 0, 0, 0]. For + the `rgba256` colormodel, it is [0, 0, 0, 0]. For the + `hsl` colormodel, it is [0, 0, 0]. For the `hsla` + colormodel, it is [0, 0, 0, 0]. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + zsmooth + Picks a smoothing algorithm used to smooth `z` data. + This only applies for image traces that use the + `source` attribute. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Image + """ + super().__init__("image") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Image +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Image`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("colormodel", arg, colormodel) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("source", arg, source) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("z", arg, z) + self._set_property("zmax", arg, zmax) + self._set_property("zmin", arg, zmin) + self._set_property("zorder", arg, zorder) + self._set_property("zsmooth", arg, zsmooth) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "image" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_indicator.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_indicator.py new file mode 100644 index 0000000..ae35450 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_indicator.py @@ -0,0 +1,848 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Indicator(_BaseTraceType): + _parent_path_str = "" + _path_str = "indicator" + _valid_props = { + "align", + "customdata", + "customdatasrc", + "delta", + "domain", + "gauge", + "ids", + "idssrc", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "meta", + "metasrc", + "mode", + "name", + "number", + "stream", + "title", + "type", + "uid", + "uirevision", + "value", + "visible", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. + Note that this attribute has no effect if an angular gauge is + displayed: in this case, it is always centered + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def delta(self): + """ + The 'delta' property is an instance of Delta + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Delta` + - A dict of string/value properties that will be passed + to the Delta constructor + + Returns + ------- + plotly.graph_objs.indicator.Delta + """ + return self["delta"] + + @delta.setter + def delta(self, val): + self["delta"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.indicator.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def gauge(self): + """ + The gauge of the Indicator plot. + + The 'gauge' property is an instance of Gauge + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Gauge` + - A dict of string/value properties that will be passed + to the Gauge constructor + + Returns + ------- + plotly.graph_objs.indicator.Gauge + """ + return self["gauge"] + + @gauge.setter + def gauge(self, val): + self["gauge"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.indicator.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines how the value is displayed on the graph. `number` + displays the value numerically in text. `delta` displays the + difference to a reference value in text. Finally, `gauge` + displays the value graphically on an axis. + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['number', 'delta', 'gauge'] joined with '+' characters + (e.g. 'number+delta') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def number(self): + """ + The 'number' property is an instance of Number + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Number` + - A dict of string/value properties that will be passed + to the Number constructor + + Returns + ------- + plotly.graph_objs.indicator.Number + """ + return self["number"] + + @number.setter + def number(self, val): + self["number"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.indicator.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.indicator.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def value(self): + """ + Sets the number to be displayed. + + The 'value' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Note that this attribute has no effect if an + angular gauge is displayed: in this case, it is always + centered + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delta + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties + domain + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties + gauge + The gauge of the Indicator plot. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.indicator.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines how the value is displayed on the graph. + `number` displays the value numerically in text. + `delta` displays the difference to a reference value in + text. Finally, `gauge` displays the value graphically + on an axis. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + number + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties + stream + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties + title + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the number to be displayed. + 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). + """ + + def __init__( + self, + arg=None, + align=None, + customdata=None, + customdatasrc=None, + delta=None, + domain=None, + gauge=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + mode=None, + name=None, + number=None, + stream=None, + title=None, + uid=None, + uirevision=None, + value=None, + visible=None, + **kwargs, + ): + """ + Construct a new Indicator object + + An indicator is used to visualize a single `value` along with + some contextual information such as `steps` or a `threshold`, + using a combination of three visual elements: a number, a + delta, and/or a gauge. Deltas are taken with respect to a + `reference`. Gauges can be either angular or bullet (aka + linear) gauges. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Indicator` + align + Sets the horizontal alignment of the `text` within the + box. Note that this attribute has no effect if an + angular gauge is displayed: in this case, it is always + centered + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delta + :class:`plotly.graph_objects.indicator.Delta` instance + or dict with compatible properties + domain + :class:`plotly.graph_objects.indicator.Domain` instance + or dict with compatible properties + gauge + The gauge of the Indicator plot. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.indicator.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines how the value is displayed on the graph. + `number` displays the value numerically in text. + `delta` displays the difference to a reference value in + text. Finally, `gauge` displays the value graphically + on an axis. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + number + :class:`plotly.graph_objects.indicator.Number` instance + or dict with compatible properties + stream + :class:`plotly.graph_objects.indicator.Stream` instance + or dict with compatible properties + title + :class:`plotly.graph_objects.indicator.Title` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the number to be displayed. + 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). + + Returns + ------- + Indicator + """ + super().__init__("indicator") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Indicator +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Indicator`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("delta", arg, delta) + self._set_property("domain", arg, domain) + self._set_property("gauge", arg, gauge) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("number", arg, number) + self._set_property("stream", arg, stream) + self._set_property("title", arg, title) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("value", arg, value) + self._set_property("visible", arg, visible) + + self._props["type"] = "indicator" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_isosurface.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_isosurface.py new file mode 100644 index 0000000..1705fcf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_isosurface.py @@ -0,0 +1,2161 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Isosurface(_BaseTraceType): + _parent_path_str = "" + _path_str = "isosurface" + _valid_props = { + "autocolorscale", + "caps", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colorscale", + "contour", + "customdata", + "customdatasrc", + "flatshading", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "isomax", + "isomin", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lighting", + "lightposition", + "meta", + "metasrc", + "name", + "opacity", + "reversescale", + "scene", + "showlegend", + "showscale", + "slices", + "spaceframe", + "stream", + "surface", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "value", + "valuehoverformat", + "valuesrc", + "visible", + "x", + "xhoverformat", + "xsrc", + "y", + "yhoverformat", + "ysrc", + "z", + "zhoverformat", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def caps(self): + """ + The 'caps' property is an instance of Caps + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Caps` + - A dict of string/value properties that will be passed + to the Caps constructor + + Returns + ------- + plotly.graph_objs.isosurface.Caps + """ + return self["caps"] + + @caps.setter + def caps(self, val): + self["caps"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here `value`) or the bounds set in + `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` + are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as `value` and if set, `cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as `value`. Has no effect when `cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as `value` and if set, `cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.isosurface.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def contour(self): + """ + The 'contour' property is an instance of Contour + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Contour` + - A dict of string/value properties that will be passed + to the Contour constructor + + Returns + ------- + plotly.graph_objs.isosurface.Contour + """ + return self["contour"] + + @contour.setter + def contour(self, val): + self["contour"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def flatshading(self): + """ + Determines whether or not normal smoothing is applied to the + meshes, creating meshes with an angular, low-poly look via flat + reflections. + + The 'flatshading' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["flatshading"] + + @flatshading.setter + def flatshading(self, val): + self["flatshading"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.isosurface.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def isomax(self): + """ + Sets the maximum boundary for iso-surface plot. + + The 'isomax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["isomax"] + + @isomax.setter + def isomax(self, val): + self["isomax"] = val + + @property + def isomin(self): + """ + Sets the minimum boundary for iso-surface plot. + + The 'isomin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["isomin"] + + @isomin.setter + def isomin(self, val): + self["isomin"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.isosurface.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Lighting` + - A dict of string/value properties that will be passed + to the Lighting constructor + + Returns + ------- + plotly.graph_objs.isosurface.Lighting + """ + return self["lighting"] + + @lighting.setter + def lighting(self, val): + self["lighting"] = val + + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Lightposition` + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Returns + ------- + plotly.graph_objs.isosurface.Lightposition + """ + return self["lightposition"] + + @lightposition.setter + def lightposition(self, val): + self["lightposition"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def slices(self): + """ + The 'slices' property is an instance of Slices + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Slices` + - A dict of string/value properties that will be passed + to the Slices constructor + + Returns + ------- + plotly.graph_objs.isosurface.Slices + """ + return self["slices"] + + @slices.setter + def slices(self, val): + self["slices"] = val + + @property + def spaceframe(self): + """ + The 'spaceframe' property is an instance of Spaceframe + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Spaceframe` + - A dict of string/value properties that will be passed + to the Spaceframe constructor + + Returns + ------- + plotly.graph_objs.isosurface.Spaceframe + """ + return self["spaceframe"] + + @spaceframe.setter + def spaceframe(self, val): + self["spaceframe"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.isosurface.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def surface(self): + """ + The 'surface' property is an instance of Surface + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.Surface` + - A dict of string/value properties that will be passed + to the Surface constructor + + Returns + ------- + plotly.graph_objs.isosurface.Surface + """ + return self["surface"] + + @surface.setter + def surface(self, val): + self["surface"] = val + + @property + def text(self): + """ + Sets the text elements associated with the vertices. If trace + `hoverinfo` contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def value(self): + """ + Sets the 4th dimension (value) of the vertices. + + The 'value' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valuehoverformat(self): + """ + Sets the hover text formatting rulefor `value` using d3 + formatting mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'valuehoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["valuehoverformat"] + + @valuehoverformat.setter + def valuehoverformat(self, val): + self["valuehoverformat"] = val + + @property + def valuesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `value`. + + The 'valuesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuesrc"] + + @valuesrc.setter + def valuesrc(self, val): + self["valuesrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the X coordinates of the vertices on X axis. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the Y coordinates of the vertices on Y axis. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the Z coordinates of the vertices on Z axis. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.isosurface.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties + spaceframe + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties + surface + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuehoverformat=None, + valuesrc=None, + visible=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Isosurface object + + Draws isosurfaces between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Isosurface` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.isosurface.Caps` instance + or dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.isosurface.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.isosurface.Contour` + instance or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.isosurface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.isosurface.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.isosurface.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.isosurface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.isosurface.Slices` + instance or dict with compatible properties + spaceframe + :class:`plotly.graph_objects.isosurface.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.isosurface.Stream` + instance or dict with compatible properties + surface + :class:`plotly.graph_objects.isosurface.Surface` + instance or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Isosurface + """ + super().__init__("isosurface") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Isosurface +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Isosurface`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("caps", arg, caps) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("contour", arg, contour) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("flatshading", arg, flatshading) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("isomax", arg, isomax) + self._set_property("isomin", arg, isomin) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lighting", arg, lighting) + self._set_property("lightposition", arg, lightposition) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("slices", arg, slices) + self._set_property("spaceframe", arg, spaceframe) + self._set_property("stream", arg, stream) + self._set_property("surface", arg, surface) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("value", arg, value) + self._set_property("valuehoverformat", arg, valuehoverformat) + self._set_property("valuesrc", arg, valuesrc) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "isosurface" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_layout.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_layout.py new file mode 100644 index 0000000..2a08e49 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_layout.py @@ -0,0 +1,3507 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutType as _BaseLayoutType +import copy as _copy + + +class Layout(_BaseLayoutType): + _subplotid_prop_names = [ + "coloraxis", + "geo", + "legend", + "map", + "mapbox", + "polar", + "scene", + "smith", + "ternary", + "xaxis", + "yaxis", + ] + + import re + + _subplotid_prop_re = re.compile("^(" + "|".join(_subplotid_prop_names) + r")(\d+)$") + + @property + def _subplotid_validators(self): + """ + dict of validator classes for each subplot type + + Returns + ------- + dict + """ + from plotly.validator_cache import ValidatorCache + + return { + "coloraxis": ValidatorCache.get_validator("layout", "coloraxis"), + "geo": ValidatorCache.get_validator("layout", "geo"), + "legend": ValidatorCache.get_validator("layout", "legend"), + "map": ValidatorCache.get_validator("layout", "map"), + "mapbox": ValidatorCache.get_validator("layout", "mapbox"), + "polar": ValidatorCache.get_validator("layout", "polar"), + "scene": ValidatorCache.get_validator("layout", "scene"), + "smith": ValidatorCache.get_validator("layout", "smith"), + "ternary": ValidatorCache.get_validator("layout", "ternary"), + "xaxis": ValidatorCache.get_validator("layout", "xaxis"), + "yaxis": ValidatorCache.get_validator("layout", "yaxis"), + } + + def _subplot_re_match(self, prop): + return self._subplotid_prop_re.match(prop) + + _parent_path_str = "" + _path_str = "layout" + _valid_props = { + "activeselection", + "activeshape", + "annotationdefaults", + "annotations", + "autosize", + "autotypenumbers", + "barcornerradius", + "bargap", + "bargroupgap", + "barmode", + "barnorm", + "boxgap", + "boxgroupgap", + "boxmode", + "calendar", + "clickmode", + "coloraxis", + "colorscale", + "colorway", + "computed", + "datarevision", + "dragmode", + "editrevision", + "extendfunnelareacolors", + "extendiciclecolors", + "extendpiecolors", + "extendsunburstcolors", + "extendtreemapcolors", + "font", + "funnelareacolorway", + "funnelgap", + "funnelgroupgap", + "funnelmode", + "geo", + "grid", + "height", + "hiddenlabels", + "hiddenlabelssrc", + "hidesources", + "hoverdistance", + "hoverlabel", + "hovermode", + "hoversubplots", + "iciclecolorway", + "imagedefaults", + "images", + "legend", + "map", + "mapbox", + "margin", + "meta", + "metasrc", + "minreducedheight", + "minreducedwidth", + "modebar", + "newselection", + "newshape", + "paper_bgcolor", + "piecolorway", + "plot_bgcolor", + "polar", + "scattergap", + "scattermode", + "scene", + "selectdirection", + "selectiondefaults", + "selectionrevision", + "selections", + "separators", + "shapedefaults", + "shapes", + "showlegend", + "sliderdefaults", + "sliders", + "smith", + "spikedistance", + "sunburstcolorway", + "template", + "ternary", + "title", + "transition", + "treemapcolorway", + "uirevision", + "uniformtext", + "updatemenudefaults", + "updatemenus", + "violingap", + "violingroupgap", + "violinmode", + "waterfallgap", + "waterfallgroupgap", + "waterfallmode", + "width", + "xaxis", + "yaxis", + } + + @property + def activeselection(self): + """ + The 'activeselection' property is an instance of Activeselection + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Activeselection` + - A dict of string/value properties that will be passed + to the Activeselection constructor + + Returns + ------- + plotly.graph_objs.layout.Activeselection + """ + return self["activeselection"] + + @activeselection.setter + def activeselection(self, val): + self["activeselection"] = val + + @property + def activeshape(self): + """ + The 'activeshape' property is an instance of Activeshape + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Activeshape` + - A dict of string/value properties that will be passed + to the Activeshape constructor + + Returns + ------- + plotly.graph_objs.layout.Activeshape + """ + return self["activeshape"] + + @activeshape.setter + def activeshape(self, val): + self["activeshape"] = val + + @property + def annotations(self): + """ + The 'annotations' property is a tuple of instances of + Annotation that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Annotation + - A list or tuple of dicts of string/value properties that + will be passed to the Annotation constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.Annotation] + """ + return self["annotations"] + + @annotations.setter + def annotations(self, val): + self["annotations"] = val + + @property + def annotationdefaults(self): + """ + When used in a template (as + layout.template.layout.annotationdefaults), sets the default + property values to use for elements of layout.annotations + + The 'annotationdefaults' property is an instance of Annotation + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Annotation` + - A dict of string/value properties that will be passed + to the Annotation constructor + + Returns + ------- + plotly.graph_objs.layout.Annotation + """ + return self["annotationdefaults"] + + @annotationdefaults.setter + def annotationdefaults(self, val): + self["annotationdefaults"] = val + + @property + def autosize(self): + """ + Determines whether or not a layout width or height that has + been left undefined by the user is initialized on each + relayout. Note that, regardless of this attribute, an undefined + layout width or height is always initialized on the first call + to plot. + + The 'autosize' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autosize"] + + @autosize.setter + def autosize(self, val): + self["autosize"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. This is the default value; however it could be + overridden for individual axes. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def barcornerradius(self): + """ + Sets the rounding of bar corners. May be an integer number of + pixels, or a percentage of bar width (as a string ending in %). + + The 'barcornerradius' property accepts values of any type + + Returns + ------- + Any + """ + return self["barcornerradius"] + + @barcornerradius.setter + def barcornerradius(self, val): + self["barcornerradius"] = val + + @property + def bargap(self): + """ + Sets the gap (in plot fraction) between bars of adjacent + location coordinates. + + The 'bargap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["bargap"] + + @bargap.setter + def bargap(self, val): + self["bargap"] = val + + @property + def bargroupgap(self): + """ + Sets the gap (in plot fraction) between bars of the same + location coordinate. + + The 'bargroupgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["bargroupgap"] + + @bargroupgap.setter + def bargroupgap(self, val): + self["bargroupgap"] = val + + @property + def barmode(self): + """ + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are stacked on + top of one another With "relative", the bars are stacked on top + of one another, with negative values below the axis, positive + values above With "group", the bars are plotted next to one + another centered around the shared location. With "overlay", + the bars are plotted over one another, you might need to reduce + "opacity" to see multiple bars. + + The 'barmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['stack', 'group', 'overlay', 'relative'] + + Returns + ------- + Any + """ + return self["barmode"] + + @barmode.setter + def barmode(self, val): + self["barmode"] = val + + @property + def barnorm(self): + """ + Sets the normalization for bar traces on the graph. With + "fraction", the value of each bar is divided by the sum of all + values at that location coordinate. "percent" is the same but + multiplied by 100 to show percentages. + + The 'barnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'fraction', 'percent'] + + Returns + ------- + Any + """ + return self["barnorm"] + + @barnorm.setter + def barnorm(self, val): + self["barnorm"] = val + + @property + def boxgap(self): + """ + Sets the gap (in plot fraction) between boxes of adjacent + location coordinates. Has no effect on traces that have "width" + set. + + The 'boxgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["boxgap"] + + @boxgap.setter + def boxgap(self, val): + self["boxgap"] = val + + @property + def boxgroupgap(self): + """ + Sets the gap (in plot fraction) between boxes of the same + location coordinate. Has no effect on traces that have "width" + set. + + The 'boxgroupgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["boxgroupgap"] + + @boxgroupgap.setter + def boxgroupgap(self, val): + self["boxgroupgap"] = val + + @property + def boxmode(self): + """ + Determines how boxes at the same location coordinate are + displayed on the graph. If "group", the boxes are plotted next + to one another centered around the shared location. If + "overlay", the boxes are plotted over one another, you might + need to set "opacity" to see them multiple boxes. Has no effect + on traces that have "width" set. + + The 'boxmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['group', 'overlay'] + + Returns + ------- + Any + """ + return self["boxmode"] + + @boxmode.setter + def boxmode(self, val): + self["boxmode"] = val + + @property + def calendar(self): + """ + Sets the default calendar system to use for interpreting and + displaying dates throughout the plot. + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def clickmode(self): + """ + Determines the mode of single click interactions. "event" is + the default value and emits the `plotly_click` event. In + addition this mode emits the `plotly_selected` event in drag + modes "lasso" and "select", but with no event data attached + (kept for compatibility reasons). The "select" flag enables + selecting single data points via click. This mode also supports + persistent selections, meaning that pressing Shift while + clicking, adds to / subtracts from an existing selection. + "select" with `hovermode`: "x" can be confusing, consider + explicitly setting `hovermode`: "closest" when using this + feature. Selection events are sent accordingly as long as + "event" flag is set as well. When the "event" flag is missing, + `plotly_click` and `plotly_selected` events are not fired. + + The 'clickmode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['event', 'select'] joined with '+' characters + (e.g. 'event+select') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["clickmode"] + + @clickmode.setter + def clickmode(self, val): + self["clickmode"] = val + + @property + def coloraxis(self): + """ + The 'coloraxis' property is an instance of Coloraxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Coloraxis` + - A dict of string/value properties that will be passed + to the Coloraxis constructor + + Returns + ------- + plotly.graph_objs.layout.Coloraxis + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + The 'colorscale' property is an instance of Colorscale + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Colorscale` + - A dict of string/value properties that will be passed + to the Colorscale constructor + + Returns + ------- + plotly.graph_objs.layout.Colorscale + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorway(self): + """ + Sets the default trace colors. + + The 'colorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self["colorway"] + + @colorway.setter + def colorway(self, val): + self["colorway"] = val + + @property + def computed(self): + """ + Placeholder for exporting automargin-impacting values namely + `margin.t`, `margin.b`, `margin.l` and `margin.r` in "full- + json" mode. + + The 'computed' property accepts values of any type + + Returns + ------- + Any + """ + return self["computed"] + + @computed.setter + def computed(self, val): + self["computed"] = val + + @property + def datarevision(self): + """ + If provided, a changed value tells `Plotly.react` that one or + more data arrays has changed. This way you can modify arrays + in-place rather than making a complete new copy for an + incremental change. If NOT provided, `Plotly.react` assumes + that data arrays are being treated as immutable, thus any data + array with a different identity from its predecessor contains + new data. + + The 'datarevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["datarevision"] + + @datarevision.setter + def datarevision(self, val): + self["datarevision"] = val + + @property + def dragmode(self): + """ + Determines the mode of drag interactions. "select" and "lasso" + apply only to scatter traces with markers or text. "orbit" and + "turntable" apply only to 3D scenes. + + The 'dragmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['zoom', 'pan', 'select', 'lasso', 'drawclosedpath', + 'drawopenpath', 'drawline', 'drawrect', 'drawcircle', + 'orbit', 'turntable', False] + + Returns + ------- + Any + """ + return self["dragmode"] + + @dragmode.setter + def dragmode(self, val): + self["dragmode"] = val + + @property + def editrevision(self): + """ + Controls persistence of user-driven changes in `editable: true` + configuration, other than trace names and axis titles. Defaults + to `layout.uirevision`. + + The 'editrevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["editrevision"] + + @editrevision.setter + def editrevision(self, val): + self["editrevision"] = val + + @property + def extendfunnelareacolors(self): + """ + If `true`, the funnelarea slice colors (whether given by + `funnelareacolorway` or inherited from `colorway`) will be + extended to three times its original length by first repeating + every color 20% lighter then each color 20% darker. This is + intended to reduce the likelihood of reusing the same color + when you have many slices, but you can set `false` to disable. + Colors provided in the trace, using `marker.colors`, are never + extended. + + The 'extendfunnelareacolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["extendfunnelareacolors"] + + @extendfunnelareacolors.setter + def extendfunnelareacolors(self, val): + self["extendfunnelareacolors"] = val + + @property + def extendiciclecolors(self): + """ + If `true`, the icicle slice colors (whether given by + `iciclecolorway` or inherited from `colorway`) will be extended + to three times its original length by first repeating every + color 20% lighter then each color 20% darker. This is intended + to reduce the likelihood of reusing the same color when you + have many slices, but you can set `false` to disable. Colors + provided in the trace, using `marker.colors`, are never + extended. + + The 'extendiciclecolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["extendiciclecolors"] + + @extendiciclecolors.setter + def extendiciclecolors(self, val): + self["extendiciclecolors"] = val + + @property + def extendpiecolors(self): + """ + If `true`, the pie slice colors (whether given by `piecolorway` + or inherited from `colorway`) will be extended to three times + its original length by first repeating every color 20% lighter + then each color 20% darker. This is intended to reduce the + likelihood of reusing the same color when you have many slices, + but you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + + The 'extendpiecolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["extendpiecolors"] + + @extendpiecolors.setter + def extendpiecolors(self, val): + self["extendpiecolors"] = val + + @property + def extendsunburstcolors(self): + """ + If `true`, the sunburst slice colors (whether given by + `sunburstcolorway` or inherited from `colorway`) will be + extended to three times its original length by first repeating + every color 20% lighter then each color 20% darker. This is + intended to reduce the likelihood of reusing the same color + when you have many slices, but you can set `false` to disable. + Colors provided in the trace, using `marker.colors`, are never + extended. + + The 'extendsunburstcolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["extendsunburstcolors"] + + @extendsunburstcolors.setter + def extendsunburstcolors(self, val): + self["extendsunburstcolors"] = val + + @property + def extendtreemapcolors(self): + """ + If `true`, the treemap slice colors (whether given by + `treemapcolorway` or inherited from `colorway`) will be + extended to three times its original length by first repeating + every color 20% lighter then each color 20% darker. This is + intended to reduce the likelihood of reusing the same color + when you have many slices, but you can set `false` to disable. + Colors provided in the trace, using `marker.colors`, are never + extended. + + The 'extendtreemapcolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["extendtreemapcolors"] + + @extendtreemapcolors.setter + def extendtreemapcolors(self, val): + self["extendtreemapcolors"] = val + + @property + def font(self): + """ + Sets the global font. Note that fonts used in traces and other + layout components inherit from the global font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def funnelareacolorway(self): + """ + Sets the default funnelarea slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new list + here it can still be extended with lighter and darker colors, + see `extendfunnelareacolors`. + + The 'funnelareacolorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self["funnelareacolorway"] + + @funnelareacolorway.setter + def funnelareacolorway(self, val): + self["funnelareacolorway"] = val + + @property + def funnelgap(self): + """ + Sets the gap (in plot fraction) between bars of adjacent + location coordinates. + + The 'funnelgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["funnelgap"] + + @funnelgap.setter + def funnelgap(self, val): + self["funnelgap"] = val + + @property + def funnelgroupgap(self): + """ + Sets the gap (in plot fraction) between bars of the same + location coordinate. + + The 'funnelgroupgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["funnelgroupgap"] + + @funnelgroupgap.setter + def funnelgroupgap(self, val): + self["funnelgroupgap"] = val + + @property + def funnelmode(self): + """ + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are stacked on + top of one another With "group", the bars are plotted next to + one another centered around the shared location. With + "overlay", the bars are plotted over one another, you might + need to reduce "opacity" to see multiple bars. + + The 'funnelmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['stack', 'group', 'overlay'] + + Returns + ------- + Any + """ + return self["funnelmode"] + + @funnelmode.setter + def funnelmode(self, val): + self["funnelmode"] = val + + @property + def geo(self): + """ + The 'geo' property is an instance of Geo + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Geo` + - A dict of string/value properties that will be passed + to the Geo constructor + + Returns + ------- + plotly.graph_objs.layout.Geo + """ + return self["geo"] + + @geo.setter + def geo(self, val): + self["geo"] = val + + @property + def grid(self): + """ + The 'grid' property is an instance of Grid + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Grid` + - A dict of string/value properties that will be passed + to the Grid constructor + + Returns + ------- + plotly.graph_objs.layout.Grid + """ + return self["grid"] + + @grid.setter + def grid(self, val): + self["grid"] = val + + @property + def height(self): + """ + Sets the plot's height (in px). + + The 'height' property is a number and may be specified as: + - An int or float in the interval [10, inf] + + Returns + ------- + int|float + """ + return self["height"] + + @height.setter + def height(self, val): + self["height"] = val + + @property + def hiddenlabels(self): + """ + hiddenlabels is the funnelarea & pie chart analog of + visible:'legendonly' but it can contain many labels, and can + simultaneously hide slices from several pies/funnelarea charts + + The 'hiddenlabels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["hiddenlabels"] + + @hiddenlabels.setter + def hiddenlabels(self, val): + self["hiddenlabels"] = val + + @property + def hiddenlabelssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hiddenlabels`. + + The 'hiddenlabelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hiddenlabelssrc"] + + @hiddenlabelssrc.setter + def hiddenlabelssrc(self, val): + self["hiddenlabelssrc"] = val + + @property + def hidesources(self): + """ + Determines whether or not a text link citing the data source is + placed at the bottom-right cored of the figure. Has only an + effect only on graphs that have been generated via forked + graphs from the Chart Studio Cloud (at https://chart- + studio.plotly.com or on-premise). + + The 'hidesources' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["hidesources"] + + @hidesources.setter + def hidesources(self, val): + self["hidesources"] = val + + @property + def hoverdistance(self): + """ + Sets the default distance (in pixels) to look for data to add + hover labels (-1 means no cutoff, 0 means no looking for data). + This is only a real distance for hovering on point-like + objects, like scatter points. For area-like objects (bars, + scatter fills, etc) hovering is on inside the area and off + outside, but these objects will not supersede hover on point- + like objects in case of conflict. + + The 'hoverdistance' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + + Returns + ------- + int + """ + return self["hoverdistance"] + + @hoverdistance.setter + def hoverdistance(self, val): + self["hoverdistance"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.layout.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovermode(self): + """ + Determines the mode of hover interactions. If "closest", a + single hoverlabel will appear for the "closest" point within + the `hoverdistance`. If "x" (or "y"), multiple hoverlabels will + appear for multiple points at the "closest" x- (or y-) + coordinate within the `hoverdistance`, with the caveat that no + more than one hoverlabel will appear per trace. If *x unified* + (or *y unified*), a single hoverlabel will appear multiple + points at the closest x- (or y-) coordinate within the + `hoverdistance` with the caveat that no more than one + hoverlabel will appear per trace. In this mode, spikelines are + enabled by default perpendicular to the specified axis. If + false, hover interactions are disabled. + + The 'hovermode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['x', 'y', 'closest', False, 'x unified', 'y unified'] + + Returns + ------- + Any + """ + return self["hovermode"] + + @hovermode.setter + def hovermode(self, val): + self["hovermode"] = val + + @property + def hoversubplots(self): + """ + Determines expansion of hover effects to other subplots If + "single" just the axis pair of the primary point is included + without overlaying subplots. If "overlaying" all subplots using + the main axis and occupying the same space are included. If + "axis", also include stacked subplots using the same axis when + `hovermode` is set to "x", *x unified*, "y" or *y unified*. + + The 'hoversubplots' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['single', 'overlaying', 'axis'] + + Returns + ------- + Any + """ + return self["hoversubplots"] + + @hoversubplots.setter + def hoversubplots(self, val): + self["hoversubplots"] = val + + @property + def iciclecolorway(self): + """ + Sets the default icicle slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new list + here it can still be extended with lighter and darker colors, + see `extendiciclecolors`. + + The 'iciclecolorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self["iciclecolorway"] + + @iciclecolorway.setter + def iciclecolorway(self, val): + self["iciclecolorway"] = val + + @property + def images(self): + """ + The 'images' property is a tuple of instances of + Image that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Image + - A list or tuple of dicts of string/value properties that + will be passed to the Image constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.Image] + """ + return self["images"] + + @images.setter + def images(self, val): + self["images"] = val + + @property + def imagedefaults(self): + """ + When used in a template (as + layout.template.layout.imagedefaults), sets the default + property values to use for elements of layout.images + + The 'imagedefaults' property is an instance of Image + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Image` + - A dict of string/value properties that will be passed + to the Image constructor + + Returns + ------- + plotly.graph_objs.layout.Image + """ + return self["imagedefaults"] + + @imagedefaults.setter + def imagedefaults(self, val): + self["imagedefaults"] = val + + @property + def legend(self): + """ + The 'legend' property is an instance of Legend + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Legend` + - A dict of string/value properties that will be passed + to the Legend constructor + + Returns + ------- + plotly.graph_objs.layout.Legend + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def map(self): + """ + The 'map' property is an instance of Map + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Map` + - A dict of string/value properties that will be passed + to the Map constructor + + Returns + ------- + plotly.graph_objs.layout.Map + """ + return self["map"] + + @map.setter + def map(self, val): + self["map"] = val + + @property + def mapbox(self): + """ + The 'mapbox' property is an instance of Mapbox + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Mapbox` + - A dict of string/value properties that will be passed + to the Mapbox constructor + + Returns + ------- + plotly.graph_objs.layout.Mapbox + """ + return self["mapbox"] + + @mapbox.setter + def mapbox(self, val): + self["mapbox"] = val + + @property + def margin(self): + """ + The 'margin' property is an instance of Margin + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Margin` + - A dict of string/value properties that will be passed + to the Margin constructor + + Returns + ------- + plotly.graph_objs.layout.Margin + """ + return self["margin"] + + @margin.setter + def margin(self, val): + self["margin"] = val + + @property + def meta(self): + """ + Assigns extra meta information that can be used in various + `text` attributes. Attributes such as the graph, axis and + colorbar `title.text`, annotation `text` `trace.name` in legend + items, `rangeselector`, `updatemenus` and `sliders` `label` + text all support `meta`. One can access `meta` fields using + template strings: `%{meta[i]}` where `i` is the index of the + `meta` item in question. `meta` can also be an object for + example `{key: value}` which can be accessed %{meta[key]}. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def minreducedheight(self): + """ + Minimum height of the plot with margin.automargin applied (in + px) + + The 'minreducedheight' property is a number and may be specified as: + - An int or float in the interval [2, inf] + + Returns + ------- + int|float + """ + return self["minreducedheight"] + + @minreducedheight.setter + def minreducedheight(self, val): + self["minreducedheight"] = val + + @property + def minreducedwidth(self): + """ + Minimum width of the plot with margin.automargin applied (in + px) + + The 'minreducedwidth' property is a number and may be specified as: + - An int or float in the interval [2, inf] + + Returns + ------- + int|float + """ + return self["minreducedwidth"] + + @minreducedwidth.setter + def minreducedwidth(self, val): + self["minreducedwidth"] = val + + @property + def modebar(self): + """ + The 'modebar' property is an instance of Modebar + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Modebar` + - A dict of string/value properties that will be passed + to the Modebar constructor + + Returns + ------- + plotly.graph_objs.layout.Modebar + """ + return self["modebar"] + + @modebar.setter + def modebar(self, val): + self["modebar"] = val + + @property + def newselection(self): + """ + The 'newselection' property is an instance of Newselection + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Newselection` + - A dict of string/value properties that will be passed + to the Newselection constructor + + Returns + ------- + plotly.graph_objs.layout.Newselection + """ + return self["newselection"] + + @newselection.setter + def newselection(self, val): + self["newselection"] = val + + @property + def newshape(self): + """ + The 'newshape' property is an instance of Newshape + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Newshape` + - A dict of string/value properties that will be passed + to the Newshape constructor + + Returns + ------- + plotly.graph_objs.layout.Newshape + """ + return self["newshape"] + + @newshape.setter + def newshape(self, val): + self["newshape"] = val + + @property + def paper_bgcolor(self): + """ + Sets the background color of the paper where the graph is + drawn. + + The 'paper_bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["paper_bgcolor"] + + @paper_bgcolor.setter + def paper_bgcolor(self, val): + self["paper_bgcolor"] = val + + @property + def piecolorway(self): + """ + Sets the default pie slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new list + here it can still be extended with lighter and darker colors, + see `extendpiecolors`. + + The 'piecolorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self["piecolorway"] + + @piecolorway.setter + def piecolorway(self, val): + self["piecolorway"] = val + + @property + def plot_bgcolor(self): + """ + Sets the background color of the plotting area in-between x and + y axes. + + The 'plot_bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["plot_bgcolor"] + + @plot_bgcolor.setter + def plot_bgcolor(self, val): + self["plot_bgcolor"] = val + + @property + def polar(self): + """ + The 'polar' property is an instance of Polar + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Polar` + - A dict of string/value properties that will be passed + to the Polar constructor + + Returns + ------- + plotly.graph_objs.layout.Polar + """ + return self["polar"] + + @polar.setter + def polar(self, val): + self["polar"] = val + + @property + def scattergap(self): + """ + Sets the gap (in plot fraction) between scatter points of + adjacent location coordinates. Defaults to `bargap`. + + The 'scattergap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["scattergap"] + + @scattergap.setter + def scattergap(self, val): + self["scattergap"] = val + + @property + def scattermode(self): + """ + Determines how scatter points at the same location coordinate + are displayed on the graph. With "group", the scatter points + are plotted next to one another centered around the shared + location. With "overlay", the scatter points are plotted over + one another, you might need to reduce "opacity" to see multiple + scatter points. + + The 'scattermode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['group', 'overlay'] + + Returns + ------- + Any + """ + return self["scattermode"] + + @scattermode.setter + def scattermode(self, val): + self["scattermode"] = val + + @property + def scene(self): + """ + The 'scene' property is an instance of Scene + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Scene` + - A dict of string/value properties that will be passed + to the Scene constructor + + Returns + ------- + plotly.graph_objs.layout.Scene + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def selectdirection(self): + """ + When `dragmode` is set to "select", this limits the selection + of the drag to horizontal, vertical or diagonal. "h" only + allows horizontal selection, "v" only vertical, "d" only + diagonal and "any" sets no limit. + + The 'selectdirection' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v', 'd', 'any'] + + Returns + ------- + Any + """ + return self["selectdirection"] + + @selectdirection.setter + def selectdirection(self, val): + self["selectdirection"] = val + + @property + def selectionrevision(self): + """ + Controls persistence of user-driven changes in selected points + from all traces. + + The 'selectionrevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectionrevision"] + + @selectionrevision.setter + def selectionrevision(self, val): + self["selectionrevision"] = val + + @property + def selections(self): + """ + The 'selections' property is a tuple of instances of + Selection that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Selection + - A list or tuple of dicts of string/value properties that + will be passed to the Selection constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.Selection] + """ + return self["selections"] + + @selections.setter + def selections(self, val): + self["selections"] = val + + @property + def selectiondefaults(self): + """ + When used in a template (as + layout.template.layout.selectiondefaults), sets the default + property values to use for elements of layout.selections + + The 'selectiondefaults' property is an instance of Selection + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Selection` + - A dict of string/value properties that will be passed + to the Selection constructor + + Returns + ------- + plotly.graph_objs.layout.Selection + """ + return self["selectiondefaults"] + + @selectiondefaults.setter + def selectiondefaults(self, val): + self["selectiondefaults"] = val + + @property + def separators(self): + """ + Sets the decimal and thousand separators. For example, *. * + puts a '.' before decimals and a space between thousands. In + English locales, dflt is ".," but other locales may alter this + default. + + The 'separators' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["separators"] + + @separators.setter + def separators(self, val): + self["separators"] = val + + @property + def shapes(self): + """ + The 'shapes' property is a tuple of instances of + Shape that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Shape + - A list or tuple of dicts of string/value properties that + will be passed to the Shape constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.Shape] + """ + return self["shapes"] + + @shapes.setter + def shapes(self, val): + self["shapes"] = val + + @property + def shapedefaults(self): + """ + When used in a template (as + layout.template.layout.shapedefaults), sets the default + property values to use for elements of layout.shapes + + The 'shapedefaults' property is an instance of Shape + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Shape` + - A dict of string/value properties that will be passed + to the Shape constructor + + Returns + ------- + plotly.graph_objs.layout.Shape + """ + return self["shapedefaults"] + + @shapedefaults.setter + def shapedefaults(self, val): + self["shapedefaults"] = val + + @property + def showlegend(self): + """ + Determines whether or not a legend is drawn. Default is `true` + if there is a trace to show and any of these: a) Two or more + traces would by default be shown in the legend. b) One pie + trace is shown in the legend. c) One trace is explicitly given + with `showlegend: true`. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def sliders(self): + """ + The 'sliders' property is a tuple of instances of + Slider that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Slider + - A list or tuple of dicts of string/value properties that + will be passed to the Slider constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.Slider] + """ + return self["sliders"] + + @sliders.setter + def sliders(self, val): + self["sliders"] = val + + @property + def sliderdefaults(self): + """ + When used in a template (as + layout.template.layout.sliderdefaults), sets the default + property values to use for elements of layout.sliders + + The 'sliderdefaults' property is an instance of Slider + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Slider` + - A dict of string/value properties that will be passed + to the Slider constructor + + Returns + ------- + plotly.graph_objs.layout.Slider + """ + return self["sliderdefaults"] + + @sliderdefaults.setter + def sliderdefaults(self, val): + self["sliderdefaults"] = val + + @property + def smith(self): + """ + The 'smith' property is an instance of Smith + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Smith` + - A dict of string/value properties that will be passed + to the Smith constructor + + Returns + ------- + plotly.graph_objs.layout.Smith + """ + return self["smith"] + + @smith.setter + def smith(self, val): + self["smith"] = val + + @property + def spikedistance(self): + """ + Sets the default distance (in pixels) to look for data to draw + spikelines to (-1 means no cutoff, 0 means no looking for + data). As with hoverdistance, distance does not apply to area- + like objects. In addition, some objects can be hovered on but + will not generate spikelines, such as scatter fills. + + The 'spikedistance' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + + Returns + ------- + int + """ + return self["spikedistance"] + + @spikedistance.setter + def spikedistance(self, val): + self["spikedistance"] = val + + @property + def sunburstcolorway(self): + """ + Sets the default sunburst slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new list + here it can still be extended with lighter and darker colors, + see `extendsunburstcolors`. + + The 'sunburstcolorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self["sunburstcolorway"] + + @sunburstcolorway.setter + def sunburstcolorway(self, val): + self["sunburstcolorway"] = val + + @property + def template(self): + """ + Default attributes to be applied to the plot. This should be a + dict with format: `{'layout': layoutTemplate, 'data': + {trace_type: [traceTemplate, ...], ...}}` where + `layoutTemplate` is a dict matching the structure of + `figure.layout` and `traceTemplate` is a dict matching the + structure of the trace with type `trace_type` (e.g. 'scatter'). + Alternatively, this may be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are applied + cyclically to traces of each type. Container arrays (eg + `annotations`) have special handling: An object ending in + `defaults` (eg `annotationdefaults`) is applied to each array + item. But if an item has a `templateitemname` key we look in + the template array for an item with matching `name` and apply + that instead. If no matching `name` is found we mark the item + invisible. Any named template item not referenced is appended + to the end of the array, so this can be used to add a watermark + annotation or a logo image, for example. To omit one of these + items on the plot, make an item with matching + `templateitemname` and `visible: false`. + + The 'template' property is an instance of Template + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Template` + - A dict of string/value properties that will be passed + to the Template constructor + - The name of a registered template where current registered templates + are stored in the plotly.io.templates configuration object. The names + of all registered templates can be retrieved with: + >>> import plotly.io as pio + >>> list(pio.templates) # doctest: +ELLIPSIS + ['ggplot2', 'seaborn', 'simple_white', 'plotly', 'plotly_white', ...] + + - A string containing multiple registered template names, joined on '+' + characters (e.g. 'template1+template2'). In this case the resulting + template is computed by merging together the collection of registered + templates + + Returns + ------- + plotly.graph_objs.layout.Template + """ + return self["template"] + + @template.setter + def template(self, val): + self["template"] = val + + @property + def ternary(self): + """ + The 'ternary' property is an instance of Ternary + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Ternary` + - A dict of string/value properties that will be passed + to the Ternary constructor + + Returns + ------- + plotly.graph_objs.layout.Ternary + """ + return self["ternary"] + + @ternary.setter + def ternary(self, val): + self["ternary"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def transition(self): + """ + Sets transition options used during Plotly.react updates. + + The 'transition' property is an instance of Transition + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Transition` + - A dict of string/value properties that will be passed + to the Transition constructor + + Returns + ------- + plotly.graph_objs.layout.Transition + """ + return self["transition"] + + @transition.setter + def transition(self, val): + self["transition"] = val + + @property + def treemapcolorway(self): + """ + Sets the default treemap slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new list + here it can still be extended with lighter and darker colors, + see `extendtreemapcolors`. + + The 'treemapcolorway' property is a colorlist that may be specified + as a tuple, list, one-dimensional numpy array, or pandas Series of valid + color strings + + Returns + ------- + list + """ + return self["treemapcolorway"] + + @treemapcolorway.setter + def treemapcolorway(self, val): + self["treemapcolorway"] = val + + @property + def uirevision(self): + """ + Used to allow user interactions with the plot to persist after + `Plotly.react` calls that are unaware of these interactions. If + `uirevision` is omitted, or if it is given and it changed from + the previous `Plotly.react` call, the exact new figure is used. + If `uirevision` is truthy and did NOT change, any attribute + that has been affected by user interactions and did not receive + a different value in the new figure will keep the interaction + value. `layout.uirevision` attribute serves as the default for + `uirevision` attributes in various sub-containers. For finer + control you can set these sub-attributes directly. For example, + if your app separately controls the data on the x and y axes + you might set `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y data is changed, + you can update `yaxis.uirevision=*quantity*` and the y axis + range will reset but the x axis range will retain any user- + driven zoom. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def uniformtext(self): + """ + The 'uniformtext' property is an instance of Uniformtext + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Uniformtext` + - A dict of string/value properties that will be passed + to the Uniformtext constructor + + Returns + ------- + plotly.graph_objs.layout.Uniformtext + """ + return self["uniformtext"] + + @uniformtext.setter + def uniformtext(self, val): + self["uniformtext"] = val + + @property + def updatemenus(self): + """ + The 'updatemenus' property is a tuple of instances of + Updatemenu that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.Updatemenu + - A list or tuple of dicts of string/value properties that + will be passed to the Updatemenu constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.Updatemenu] + """ + return self["updatemenus"] + + @updatemenus.setter + def updatemenus(self, val): + self["updatemenus"] = val + + @property + def updatemenudefaults(self): + """ + When used in a template (as + layout.template.layout.updatemenudefaults), sets the default + property values to use for elements of layout.updatemenus + + The 'updatemenudefaults' property is an instance of Updatemenu + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.Updatemenu` + - A dict of string/value properties that will be passed + to the Updatemenu constructor + + Returns + ------- + plotly.graph_objs.layout.Updatemenu + """ + return self["updatemenudefaults"] + + @updatemenudefaults.setter + def updatemenudefaults(self, val): + self["updatemenudefaults"] = val + + @property + def violingap(self): + """ + Sets the gap (in plot fraction) between violins of adjacent + location coordinates. Has no effect on traces that have "width" + set. + + The 'violingap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["violingap"] + + @violingap.setter + def violingap(self, val): + self["violingap"] = val + + @property + def violingroupgap(self): + """ + Sets the gap (in plot fraction) between violins of the same + location coordinate. Has no effect on traces that have "width" + set. + + The 'violingroupgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["violingroupgap"] + + @violingroupgap.setter + def violingroupgap(self, val): + self["violingroupgap"] = val + + @property + def violinmode(self): + """ + Determines how violins at the same location coordinate are + displayed on the graph. If "group", the violins are plotted + next to one another centered around the shared location. If + "overlay", the violins are plotted over one another, you might + need to set "opacity" to see them multiple violins. Has no + effect on traces that have "width" set. + + The 'violinmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['group', 'overlay'] + + Returns + ------- + Any + """ + return self["violinmode"] + + @violinmode.setter + def violinmode(self, val): + self["violinmode"] = val + + @property + def waterfallgap(self): + """ + Sets the gap (in plot fraction) between bars of adjacent + location coordinates. + + The 'waterfallgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["waterfallgap"] + + @waterfallgap.setter + def waterfallgap(self, val): + self["waterfallgap"] = val + + @property + def waterfallgroupgap(self): + """ + Sets the gap (in plot fraction) between bars of the same + location coordinate. + + The 'waterfallgroupgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["waterfallgroupgap"] + + @waterfallgroupgap.setter + def waterfallgroupgap(self, val): + self["waterfallgroupgap"] = val + + @property + def waterfallmode(self): + """ + Determines how bars at the same location coordinate are + displayed on the graph. With "group", the bars are plotted next + to one another centered around the shared location. With + "overlay", the bars are plotted over one another, you might + need to reduce "opacity" to see multiple bars. + + The 'waterfallmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['group', 'overlay'] + + Returns + ------- + Any + """ + return self["waterfallmode"] + + @waterfallmode.setter + def waterfallmode(self, val): + self["waterfallmode"] = val + + @property + def width(self): + """ + Sets the plot's width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [10, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def xaxis(self): + """ + The 'xaxis' property is an instance of XAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.XAxis` + - A dict of string/value properties that will be passed + to the XAxis constructor + + Returns + ------- + plotly.graph_objs.layout.XAxis + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def yaxis(self): + """ + The 'yaxis' property is an instance of YAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.YAxis` + - A dict of string/value properties that will be passed + to the YAxis constructor + + Returns + ------- + plotly.graph_objs.layout.YAxis + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def _prop_descriptions(self): + return """\ + activeselection + :class:`plotly.graph_objects.layout.Activeselection` + instance or dict with compatible properties + activeshape + :class:`plotly.graph_objects.layout.Activeshape` + instance or dict with compatible properties + annotations + A tuple of + :class:`plotly.graph_objects.layout.Annotation` + instances or dicts with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.annotationdefaults), sets the + default property values to use for elements of + layout.annotations + autosize + Determines whether or not a layout width or height that + has been left undefined by the user is initialized on + each relayout. Note that, regardless of this attribute, + an undefined layout width or height is always + initialized on the first call to plot. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. This is the default + value; however it could be overridden for individual + axes. + barcornerradius + Sets the rounding of bar corners. May be an integer + number of pixels, or a percentage of bar width (as a + string ending in %). + bargap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + bargroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "relative", the bars + are stacked on top of one another, with negative values + below the axis, positive values above With "group", the + bars are plotted next to one another centered around + the shared location. With "overlay", the bars are + plotted over one another, you might need to reduce + "opacity" to see multiple bars. + barnorm + Sets the normalization for bar traces on the graph. + With "fraction", the value of each bar is divided by + the sum of all values at that location coordinate. + "percent" is the same but multiplied by 100 to show + percentages. + boxgap + Sets the gap (in plot fraction) between boxes of + adjacent location coordinates. Has no effect on traces + that have "width" set. + boxgroupgap + Sets the gap (in plot fraction) between boxes of the + same location coordinate. Has no effect on traces that + have "width" set. + boxmode + Determines how boxes at the same location coordinate + are displayed on the graph. If "group", the boxes are + plotted next to one another centered around the shared + location. If "overlay", the boxes are plotted over one + another, you might need to set "opacity" to see them + multiple boxes. Has no effect on traces that have + "width" set. + calendar + Sets the default calendar system to use for + interpreting and displaying dates throughout the plot. + clickmode + Determines the mode of single click interactions. + "event" is the default value and emits the + `plotly_click` event. In addition this mode emits the + `plotly_selected` event in drag modes "lasso" and + "select", but with no event data attached (kept for + compatibility reasons). The "select" flag enables + selecting single data points via click. This mode also + supports persistent selections, meaning that pressing + Shift while clicking, adds to / subtracts from an + existing selection. "select" with `hovermode`: "x" can + be confusing, consider explicitly setting `hovermode`: + "closest" when using this feature. Selection events are + sent accordingly as long as "event" flag is set as + well. When the "event" flag is missing, `plotly_click` + and `plotly_selected` events are not fired. + coloraxis + :class:`plotly.graph_objects.layout.Coloraxis` instance + or dict with compatible properties + colorscale + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties + colorway + Sets the default trace colors. + computed + Placeholder for exporting automargin-impacting values + namely `margin.t`, `margin.b`, `margin.l` and + `margin.r` in "full-json" mode. + datarevision + If provided, a changed value tells `Plotly.react` that + one or more data arrays has changed. This way you can + modify arrays in-place rather than making a complete + new copy for an incremental change. If NOT provided, + `Plotly.react` assumes that data arrays are being + treated as immutable, thus any data array with a + different identity from its predecessor contains new + data. + dragmode + Determines the mode of drag interactions. "select" and + "lasso" apply only to scatter traces with markers or + text. "orbit" and "turntable" apply only to 3D scenes. + editrevision + Controls persistence of user-driven changes in + `editable: true` configuration, other than trace names + and axis titles. Defaults to `layout.uirevision`. + extendfunnelareacolors + If `true`, the funnelarea slice colors (whether given + by `funnelareacolorway` or inherited from `colorway`) + will be extended to three times its original length by + first repeating every color 20% lighter then each color + 20% darker. This is intended to reduce the likelihood + of reusing the same color when you have many slices, + but you can set `false` to disable. Colors provided in + the trace, using `marker.colors`, are never extended. + extendiciclecolors + If `true`, the icicle slice colors (whether given by + `iciclecolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + extendpiecolors + If `true`, the pie slice colors (whether given by + `piecolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + extendsunburstcolors + If `true`, the sunburst slice colors (whether given by + `sunburstcolorway` or inherited from `colorway`) will + be extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + extendtreemapcolors + If `true`, the treemap slice colors (whether given by + `treemapcolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + font + Sets the global font. Note that fonts used in traces + and other layout components inherit from the global + font. + funnelareacolorway + Sets the default funnelarea slice colors. Defaults to + the main `colorway` used for trace colors. If you + specify a new list here it can still be extended with + lighter and darker colors, see + `extendfunnelareacolors`. + funnelgap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + funnelgroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + funnelmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "group", the bars + are plotted next to one another centered around the + shared location. With "overlay", the bars are plotted + over one another, you might need to reduce "opacity" to + see multiple bars. + geo + :class:`plotly.graph_objects.layout.Geo` instance or + dict with compatible properties + grid + :class:`plotly.graph_objects.layout.Grid` instance or + dict with compatible properties + height + Sets the plot's height (in px). + hiddenlabels + hiddenlabels is the funnelarea & pie chart analog of + visible:'legendonly' but it can contain many labels, + and can simultaneously hide slices from several + pies/funnelarea charts + hiddenlabelssrc + Sets the source reference on Chart Studio Cloud for + `hiddenlabels`. + hidesources + Determines whether or not a text link citing the data + source is placed at the bottom-right cored of the + figure. Has only an effect only on graphs that have + been generated via forked graphs from the Chart Studio + Cloud (at https://chart-studio.plotly.com or on- + premise). + hoverdistance + Sets the default distance (in pixels) to look for data + to add hover labels (-1 means no cutoff, 0 means no + looking for data). This is only a real distance for + hovering on point-like objects, like scatter points. + For area-like objects (bars, scatter fills, etc) + hovering is on inside the area and off outside, but + these objects will not supersede hover on point-like + objects in case of conflict. + hoverlabel + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties + hovermode + Determines the mode of hover interactions. If + "closest", a single hoverlabel will appear for the + "closest" point within the `hoverdistance`. If "x" (or + "y"), multiple hoverlabels will appear for multiple + points at the "closest" x- (or y-) coordinate within + the `hoverdistance`, with the caveat that no more than + one hoverlabel will appear per trace. If *x unified* + (or *y unified*), a single hoverlabel will appear + multiple points at the closest x- (or y-) coordinate + within the `hoverdistance` with the caveat that no more + than one hoverlabel will appear per trace. In this + mode, spikelines are enabled by default perpendicular + to the specified axis. If false, hover interactions are + disabled. + hoversubplots + Determines expansion of hover effects to other subplots + If "single" just the axis pair of the primary point is + included without overlaying subplots. If "overlaying" + all subplots using the main axis and occupying the same + space are included. If "axis", also include stacked + subplots using the same axis when `hovermode` is set to + "x", *x unified*, "y" or *y unified*. + iciclecolorway + Sets the default icicle slice colors. Defaults to the + main `colorway` used for trace colors. If you specify a + new list here it can still be extended with lighter and + darker colors, see `extendiciclecolors`. + images + A tuple of :class:`plotly.graph_objects.layout.Image` + instances or dicts with compatible properties + imagedefaults + When used in a template (as + layout.template.layout.imagedefaults), sets the default + property values to use for elements of layout.images + legend + :class:`plotly.graph_objects.layout.Legend` instance or + dict with compatible properties + map + :class:`plotly.graph_objects.layout.Map` instance or + dict with compatible properties + mapbox + :class:`plotly.graph_objects.layout.Mapbox` instance or + dict with compatible properties + margin + :class:`plotly.graph_objects.layout.Margin` instance or + dict with compatible properties + meta + Assigns extra meta information that can be used in + various `text` attributes. Attributes such as the + graph, axis and colorbar `title.text`, annotation + `text` `trace.name` in legend items, `rangeselector`, + `updatemenus` and `sliders` `label` text all support + `meta`. One can access `meta` fields using template + strings: `%{meta[i]}` where `i` is the index of the + `meta` item in question. `meta` can also be an object + for example `{key: value}` which can be accessed + %{meta[key]}. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + minreducedheight + Minimum height of the plot with margin.automargin + applied (in px) + minreducedwidth + Minimum width of the plot with margin.automargin + applied (in px) + modebar + :class:`plotly.graph_objects.layout.Modebar` instance + or dict with compatible properties + newselection + :class:`plotly.graph_objects.layout.Newselection` + instance or dict with compatible properties + newshape + :class:`plotly.graph_objects.layout.Newshape` instance + or dict with compatible properties + paper_bgcolor + Sets the background color of the paper where the graph + is drawn. + piecolorway + Sets the default pie slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new + list here it can still be extended with lighter and + darker colors, see `extendpiecolors`. + plot_bgcolor + Sets the background color of the plotting area in- + between x and y axes. + polar + :class:`plotly.graph_objects.layout.Polar` instance or + dict with compatible properties + scattergap + Sets the gap (in plot fraction) between scatter points + of adjacent location coordinates. Defaults to `bargap`. + scattermode + Determines how scatter points at the same location + coordinate are displayed on the graph. With "group", + the scatter points are plotted next to one another + centered around the shared location. With "overlay", + the scatter points are plotted over one another, you + might need to reduce "opacity" to see multiple scatter + points. + scene + :class:`plotly.graph_objects.layout.Scene` instance or + dict with compatible properties + selectdirection + When `dragmode` is set to "select", this limits the + selection of the drag to horizontal, vertical or + diagonal. "h" only allows horizontal selection, "v" + only vertical, "d" only diagonal and "any" sets no + limit. + selectionrevision + Controls persistence of user-driven changes in selected + points from all traces. + selections + A tuple of + :class:`plotly.graph_objects.layout.Selection` + instances or dicts with compatible properties + selectiondefaults + When used in a template (as + layout.template.layout.selectiondefaults), sets the + default property values to use for elements of + layout.selections + separators + Sets the decimal and thousand separators. For example, + *. * puts a '.' before decimals and a space between + thousands. In English locales, dflt is ".," but other + locales may alter this default. + shapes + A tuple of :class:`plotly.graph_objects.layout.Shape` + instances or dicts with compatible properties + shapedefaults + When used in a template (as + layout.template.layout.shapedefaults), sets the default + property values to use for elements of layout.shapes + showlegend + Determines whether or not a legend is drawn. Default is + `true` if there is a trace to show and any of these: a) + Two or more traces would by default be shown in the + legend. b) One pie trace is shown in the legend. c) One + trace is explicitly given with `showlegend: true`. + sliders + A tuple of :class:`plotly.graph_objects.layout.Slider` + instances or dicts with compatible properties + sliderdefaults + When used in a template (as + layout.template.layout.sliderdefaults), sets the + default property values to use for elements of + layout.sliders + smith + :class:`plotly.graph_objects.layout.Smith` instance or + dict with compatible properties + spikedistance + Sets the default distance (in pixels) to look for data + to draw spikelines to (-1 means no cutoff, 0 means no + looking for data). As with hoverdistance, distance does + not apply to area-like objects. In addition, some + objects can be hovered on but will not generate + spikelines, such as scatter fills. + sunburstcolorway + Sets the default sunburst slice colors. Defaults to the + main `colorway` used for trace colors. If you specify a + new list here it can still be extended with lighter and + darker colors, see `extendsunburstcolors`. + template + Default attributes to be applied to the plot. This + should be a dict with format: `{'layout': + layoutTemplate, 'data': {trace_type: [traceTemplate, + ...], ...}}` where `layoutTemplate` is a dict matching + the structure of `figure.layout` and `traceTemplate` is + a dict matching the structure of the trace with type + `trace_type` (e.g. 'scatter'). Alternatively, this may + be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are + applied cyclically to traces of each type. Container + arrays (eg `annotations`) have special handling: An + object ending in `defaults` (eg `annotationdefaults`) + is applied to each array item. But if an item has a + `templateitemname` key we look in the template array + for an item with matching `name` and apply that + instead. If no matching `name` is found we mark the + item invisible. Any named template item not referenced + is appended to the end of the array, so this can be + used to add a watermark annotation or a logo image, for + example. To omit one of these items on the plot, make + an item with matching `templateitemname` and `visible: + false`. + ternary + :class:`plotly.graph_objects.layout.Ternary` instance + or dict with compatible properties + title + :class:`plotly.graph_objects.layout.Title` instance or + dict with compatible properties + transition + Sets transition options used during Plotly.react + updates. + treemapcolorway + Sets the default treemap slice colors. Defaults to the + main `colorway` used for trace colors. If you specify a + new list here it can still be extended with lighter and + darker colors, see `extendtreemapcolors`. + uirevision + Used to allow user interactions with the plot to + persist after `Plotly.react` calls that are unaware of + these interactions. If `uirevision` is omitted, or if + it is given and it changed from the previous + `Plotly.react` call, the exact new figure is used. If + `uirevision` is truthy and did NOT change, any + attribute that has been affected by user interactions + and did not receive a different value in the new figure + will keep the interaction value. `layout.uirevision` + attribute serves as the default for `uirevision` + attributes in various sub-containers. For finer control + you can set these sub-attributes directly. For example, + if your app separately controls the data on the x and y + axes you might set `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y data is + changed, you can update `yaxis.uirevision=*quantity*` + and the y axis range will reset but the x axis range + will retain any user-driven zoom. + uniformtext + :class:`plotly.graph_objects.layout.Uniformtext` + instance or dict with compatible properties + updatemenus + A tuple of + :class:`plotly.graph_objects.layout.Updatemenu` + instances or dicts with compatible properties + updatemenudefaults + When used in a template (as + layout.template.layout.updatemenudefaults), sets the + default property values to use for elements of + layout.updatemenus + violingap + Sets the gap (in plot fraction) between violins of + adjacent location coordinates. Has no effect on traces + that have "width" set. + violingroupgap + Sets the gap (in plot fraction) between violins of the + same location coordinate. Has no effect on traces that + have "width" set. + violinmode + Determines how violins at the same location coordinate + are displayed on the graph. If "group", the violins are + plotted next to one another centered around the shared + location. If "overlay", the violins are plotted over + one another, you might need to set "opacity" to see + them multiple violins. Has no effect on traces that + have "width" set. + waterfallgap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + waterfallgroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + waterfallmode + Determines how bars at the same location coordinate are + displayed on the graph. With "group", the bars are + plotted next to one another centered around the shared + location. With "overlay", the bars are plotted over one + another, you might need to reduce "opacity" to see + multiple bars. + width + Sets the plot's width (in px). + xaxis + :class:`plotly.graph_objects.layout.XAxis` instance or + dict with compatible properties + yaxis + :class:`plotly.graph_objects.layout.YAxis` instance or + dict with compatible properties + """ + + def __init__( + self, + arg=None, + activeselection=None, + activeshape=None, + annotations=None, + annotationdefaults=None, + autosize=None, + autotypenumbers=None, + barcornerradius=None, + bargap=None, + bargroupgap=None, + barmode=None, + barnorm=None, + boxgap=None, + boxgroupgap=None, + boxmode=None, + calendar=None, + clickmode=None, + coloraxis=None, + colorscale=None, + colorway=None, + computed=None, + datarevision=None, + dragmode=None, + editrevision=None, + extendfunnelareacolors=None, + extendiciclecolors=None, + extendpiecolors=None, + extendsunburstcolors=None, + extendtreemapcolors=None, + font=None, + funnelareacolorway=None, + funnelgap=None, + funnelgroupgap=None, + funnelmode=None, + geo=None, + grid=None, + height=None, + hiddenlabels=None, + hiddenlabelssrc=None, + hidesources=None, + hoverdistance=None, + hoverlabel=None, + hovermode=None, + hoversubplots=None, + iciclecolorway=None, + images=None, + imagedefaults=None, + legend=None, + map=None, + mapbox=None, + margin=None, + meta=None, + metasrc=None, + minreducedheight=None, + minreducedwidth=None, + modebar=None, + newselection=None, + newshape=None, + paper_bgcolor=None, + piecolorway=None, + plot_bgcolor=None, + polar=None, + scattergap=None, + scattermode=None, + scene=None, + selectdirection=None, + selectionrevision=None, + selections=None, + selectiondefaults=None, + separators=None, + shapes=None, + shapedefaults=None, + showlegend=None, + sliders=None, + sliderdefaults=None, + smith=None, + spikedistance=None, + sunburstcolorway=None, + template=None, + ternary=None, + title=None, + transition=None, + treemapcolorway=None, + uirevision=None, + uniformtext=None, + updatemenus=None, + updatemenudefaults=None, + violingap=None, + violingroupgap=None, + violinmode=None, + waterfallgap=None, + waterfallgroupgap=None, + waterfallmode=None, + width=None, + xaxis=None, + yaxis=None, + **kwargs, + ): + """ + Construct a new Layout object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Layout` + activeselection + :class:`plotly.graph_objects.layout.Activeselection` + instance or dict with compatible properties + activeshape + :class:`plotly.graph_objects.layout.Activeshape` + instance or dict with compatible properties + annotations + A tuple of + :class:`plotly.graph_objects.layout.Annotation` + instances or dicts with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.annotationdefaults), sets the + default property values to use for elements of + layout.annotations + autosize + Determines whether or not a layout width or height that + has been left undefined by the user is initialized on + each relayout. Note that, regardless of this attribute, + an undefined layout width or height is always + initialized on the first call to plot. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. This is the default + value; however it could be overridden for individual + axes. + barcornerradius + Sets the rounding of bar corners. May be an integer + number of pixels, or a percentage of bar width (as a + string ending in %). + bargap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + bargroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "relative", the bars + are stacked on top of one another, with negative values + below the axis, positive values above With "group", the + bars are plotted next to one another centered around + the shared location. With "overlay", the bars are + plotted over one another, you might need to reduce + "opacity" to see multiple bars. + barnorm + Sets the normalization for bar traces on the graph. + With "fraction", the value of each bar is divided by + the sum of all values at that location coordinate. + "percent" is the same but multiplied by 100 to show + percentages. + boxgap + Sets the gap (in plot fraction) between boxes of + adjacent location coordinates. Has no effect on traces + that have "width" set. + boxgroupgap + Sets the gap (in plot fraction) between boxes of the + same location coordinate. Has no effect on traces that + have "width" set. + boxmode + Determines how boxes at the same location coordinate + are displayed on the graph. If "group", the boxes are + plotted next to one another centered around the shared + location. If "overlay", the boxes are plotted over one + another, you might need to set "opacity" to see them + multiple boxes. Has no effect on traces that have + "width" set. + calendar + Sets the default calendar system to use for + interpreting and displaying dates throughout the plot. + clickmode + Determines the mode of single click interactions. + "event" is the default value and emits the + `plotly_click` event. In addition this mode emits the + `plotly_selected` event in drag modes "lasso" and + "select", but with no event data attached (kept for + compatibility reasons). The "select" flag enables + selecting single data points via click. This mode also + supports persistent selections, meaning that pressing + Shift while clicking, adds to / subtracts from an + existing selection. "select" with `hovermode`: "x" can + be confusing, consider explicitly setting `hovermode`: + "closest" when using this feature. Selection events are + sent accordingly as long as "event" flag is set as + well. When the "event" flag is missing, `plotly_click` + and `plotly_selected` events are not fired. + coloraxis + :class:`plotly.graph_objects.layout.Coloraxis` instance + or dict with compatible properties + colorscale + :class:`plotly.graph_objects.layout.Colorscale` + instance or dict with compatible properties + colorway + Sets the default trace colors. + computed + Placeholder for exporting automargin-impacting values + namely `margin.t`, `margin.b`, `margin.l` and + `margin.r` in "full-json" mode. + datarevision + If provided, a changed value tells `Plotly.react` that + one or more data arrays has changed. This way you can + modify arrays in-place rather than making a complete + new copy for an incremental change. If NOT provided, + `Plotly.react` assumes that data arrays are being + treated as immutable, thus any data array with a + different identity from its predecessor contains new + data. + dragmode + Determines the mode of drag interactions. "select" and + "lasso" apply only to scatter traces with markers or + text. "orbit" and "turntable" apply only to 3D scenes. + editrevision + Controls persistence of user-driven changes in + `editable: true` configuration, other than trace names + and axis titles. Defaults to `layout.uirevision`. + extendfunnelareacolors + If `true`, the funnelarea slice colors (whether given + by `funnelareacolorway` or inherited from `colorway`) + will be extended to three times its original length by + first repeating every color 20% lighter then each color + 20% darker. This is intended to reduce the likelihood + of reusing the same color when you have many slices, + but you can set `false` to disable. Colors provided in + the trace, using `marker.colors`, are never extended. + extendiciclecolors + If `true`, the icicle slice colors (whether given by + `iciclecolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + extendpiecolors + If `true`, the pie slice colors (whether given by + `piecolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + extendsunburstcolors + If `true`, the sunburst slice colors (whether given by + `sunburstcolorway` or inherited from `colorway`) will + be extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + extendtreemapcolors + If `true`, the treemap slice colors (whether given by + `treemapcolorway` or inherited from `colorway`) will be + extended to three times its original length by first + repeating every color 20% lighter then each color 20% + darker. This is intended to reduce the likelihood of + reusing the same color when you have many slices, but + you can set `false` to disable. Colors provided in the + trace, using `marker.colors`, are never extended. + font + Sets the global font. Note that fonts used in traces + and other layout components inherit from the global + font. + funnelareacolorway + Sets the default funnelarea slice colors. Defaults to + the main `colorway` used for trace colors. If you + specify a new list here it can still be extended with + lighter and darker colors, see + `extendfunnelareacolors`. + funnelgap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + funnelgroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + funnelmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "group", the bars + are plotted next to one another centered around the + shared location. With "overlay", the bars are plotted + over one another, you might need to reduce "opacity" to + see multiple bars. + geo + :class:`plotly.graph_objects.layout.Geo` instance or + dict with compatible properties + grid + :class:`plotly.graph_objects.layout.Grid` instance or + dict with compatible properties + height + Sets the plot's height (in px). + hiddenlabels + hiddenlabels is the funnelarea & pie chart analog of + visible:'legendonly' but it can contain many labels, + and can simultaneously hide slices from several + pies/funnelarea charts + hiddenlabelssrc + Sets the source reference on Chart Studio Cloud for + `hiddenlabels`. + hidesources + Determines whether or not a text link citing the data + source is placed at the bottom-right cored of the + figure. Has only an effect only on graphs that have + been generated via forked graphs from the Chart Studio + Cloud (at https://chart-studio.plotly.com or on- + premise). + hoverdistance + Sets the default distance (in pixels) to look for data + to add hover labels (-1 means no cutoff, 0 means no + looking for data). This is only a real distance for + hovering on point-like objects, like scatter points. + For area-like objects (bars, scatter fills, etc) + hovering is on inside the area and off outside, but + these objects will not supersede hover on point-like + objects in case of conflict. + hoverlabel + :class:`plotly.graph_objects.layout.Hoverlabel` + instance or dict with compatible properties + hovermode + Determines the mode of hover interactions. If + "closest", a single hoverlabel will appear for the + "closest" point within the `hoverdistance`. If "x" (or + "y"), multiple hoverlabels will appear for multiple + points at the "closest" x- (or y-) coordinate within + the `hoverdistance`, with the caveat that no more than + one hoverlabel will appear per trace. If *x unified* + (or *y unified*), a single hoverlabel will appear + multiple points at the closest x- (or y-) coordinate + within the `hoverdistance` with the caveat that no more + than one hoverlabel will appear per trace. In this + mode, spikelines are enabled by default perpendicular + to the specified axis. If false, hover interactions are + disabled. + hoversubplots + Determines expansion of hover effects to other subplots + If "single" just the axis pair of the primary point is + included without overlaying subplots. If "overlaying" + all subplots using the main axis and occupying the same + space are included. If "axis", also include stacked + subplots using the same axis when `hovermode` is set to + "x", *x unified*, "y" or *y unified*. + iciclecolorway + Sets the default icicle slice colors. Defaults to the + main `colorway` used for trace colors. If you specify a + new list here it can still be extended with lighter and + darker colors, see `extendiciclecolors`. + images + A tuple of :class:`plotly.graph_objects.layout.Image` + instances or dicts with compatible properties + imagedefaults + When used in a template (as + layout.template.layout.imagedefaults), sets the default + property values to use for elements of layout.images + legend + :class:`plotly.graph_objects.layout.Legend` instance or + dict with compatible properties + map + :class:`plotly.graph_objects.layout.Map` instance or + dict with compatible properties + mapbox + :class:`plotly.graph_objects.layout.Mapbox` instance or + dict with compatible properties + margin + :class:`plotly.graph_objects.layout.Margin` instance or + dict with compatible properties + meta + Assigns extra meta information that can be used in + various `text` attributes. Attributes such as the + graph, axis and colorbar `title.text`, annotation + `text` `trace.name` in legend items, `rangeselector`, + `updatemenus` and `sliders` `label` text all support + `meta`. One can access `meta` fields using template + strings: `%{meta[i]}` where `i` is the index of the + `meta` item in question. `meta` can also be an object + for example `{key: value}` which can be accessed + %{meta[key]}. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + minreducedheight + Minimum height of the plot with margin.automargin + applied (in px) + minreducedwidth + Minimum width of the plot with margin.automargin + applied (in px) + modebar + :class:`plotly.graph_objects.layout.Modebar` instance + or dict with compatible properties + newselection + :class:`plotly.graph_objects.layout.Newselection` + instance or dict with compatible properties + newshape + :class:`plotly.graph_objects.layout.Newshape` instance + or dict with compatible properties + paper_bgcolor + Sets the background color of the paper where the graph + is drawn. + piecolorway + Sets the default pie slice colors. Defaults to the main + `colorway` used for trace colors. If you specify a new + list here it can still be extended with lighter and + darker colors, see `extendpiecolors`. + plot_bgcolor + Sets the background color of the plotting area in- + between x and y axes. + polar + :class:`plotly.graph_objects.layout.Polar` instance or + dict with compatible properties + scattergap + Sets the gap (in plot fraction) between scatter points + of adjacent location coordinates. Defaults to `bargap`. + scattermode + Determines how scatter points at the same location + coordinate are displayed on the graph. With "group", + the scatter points are plotted next to one another + centered around the shared location. With "overlay", + the scatter points are plotted over one another, you + might need to reduce "opacity" to see multiple scatter + points. + scene + :class:`plotly.graph_objects.layout.Scene` instance or + dict with compatible properties + selectdirection + When `dragmode` is set to "select", this limits the + selection of the drag to horizontal, vertical or + diagonal. "h" only allows horizontal selection, "v" + only vertical, "d" only diagonal and "any" sets no + limit. + selectionrevision + Controls persistence of user-driven changes in selected + points from all traces. + selections + A tuple of + :class:`plotly.graph_objects.layout.Selection` + instances or dicts with compatible properties + selectiondefaults + When used in a template (as + layout.template.layout.selectiondefaults), sets the + default property values to use for elements of + layout.selections + separators + Sets the decimal and thousand separators. For example, + *. * puts a '.' before decimals and a space between + thousands. In English locales, dflt is ".," but other + locales may alter this default. + shapes + A tuple of :class:`plotly.graph_objects.layout.Shape` + instances or dicts with compatible properties + shapedefaults + When used in a template (as + layout.template.layout.shapedefaults), sets the default + property values to use for elements of layout.shapes + showlegend + Determines whether or not a legend is drawn. Default is + `true` if there is a trace to show and any of these: a) + Two or more traces would by default be shown in the + legend. b) One pie trace is shown in the legend. c) One + trace is explicitly given with `showlegend: true`. + sliders + A tuple of :class:`plotly.graph_objects.layout.Slider` + instances or dicts with compatible properties + sliderdefaults + When used in a template (as + layout.template.layout.sliderdefaults), sets the + default property values to use for elements of + layout.sliders + smith + :class:`plotly.graph_objects.layout.Smith` instance or + dict with compatible properties + spikedistance + Sets the default distance (in pixels) to look for data + to draw spikelines to (-1 means no cutoff, 0 means no + looking for data). As with hoverdistance, distance does + not apply to area-like objects. In addition, some + objects can be hovered on but will not generate + spikelines, such as scatter fills. + sunburstcolorway + Sets the default sunburst slice colors. Defaults to the + main `colorway` used for trace colors. If you specify a + new list here it can still be extended with lighter and + darker colors, see `extendsunburstcolors`. + template + Default attributes to be applied to the plot. This + should be a dict with format: `{'layout': + layoutTemplate, 'data': {trace_type: [traceTemplate, + ...], ...}}` where `layoutTemplate` is a dict matching + the structure of `figure.layout` and `traceTemplate` is + a dict matching the structure of the trace with type + `trace_type` (e.g. 'scatter'). Alternatively, this may + be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are + applied cyclically to traces of each type. Container + arrays (eg `annotations`) have special handling: An + object ending in `defaults` (eg `annotationdefaults`) + is applied to each array item. But if an item has a + `templateitemname` key we look in the template array + for an item with matching `name` and apply that + instead. If no matching `name` is found we mark the + item invisible. Any named template item not referenced + is appended to the end of the array, so this can be + used to add a watermark annotation or a logo image, for + example. To omit one of these items on the plot, make + an item with matching `templateitemname` and `visible: + false`. + ternary + :class:`plotly.graph_objects.layout.Ternary` instance + or dict with compatible properties + title + :class:`plotly.graph_objects.layout.Title` instance or + dict with compatible properties + transition + Sets transition options used during Plotly.react + updates. + treemapcolorway + Sets the default treemap slice colors. Defaults to the + main `colorway` used for trace colors. If you specify a + new list here it can still be extended with lighter and + darker colors, see `extendtreemapcolors`. + uirevision + Used to allow user interactions with the plot to + persist after `Plotly.react` calls that are unaware of + these interactions. If `uirevision` is omitted, or if + it is given and it changed from the previous + `Plotly.react` call, the exact new figure is used. If + `uirevision` is truthy and did NOT change, any + attribute that has been affected by user interactions + and did not receive a different value in the new figure + will keep the interaction value. `layout.uirevision` + attribute serves as the default for `uirevision` + attributes in various sub-containers. For finer control + you can set these sub-attributes directly. For example, + if your app separately controls the data on the x and y + axes you might set `xaxis.uirevision=*time*` and + `yaxis.uirevision=*cost*`. Then if only the y data is + changed, you can update `yaxis.uirevision=*quantity*` + and the y axis range will reset but the x axis range + will retain any user-driven zoom. + uniformtext + :class:`plotly.graph_objects.layout.Uniformtext` + instance or dict with compatible properties + updatemenus + A tuple of + :class:`plotly.graph_objects.layout.Updatemenu` + instances or dicts with compatible properties + updatemenudefaults + When used in a template (as + layout.template.layout.updatemenudefaults), sets the + default property values to use for elements of + layout.updatemenus + violingap + Sets the gap (in plot fraction) between violins of + adjacent location coordinates. Has no effect on traces + that have "width" set. + violingroupgap + Sets the gap (in plot fraction) between violins of the + same location coordinate. Has no effect on traces that + have "width" set. + violinmode + Determines how violins at the same location coordinate + are displayed on the graph. If "group", the violins are + plotted next to one another centered around the shared + location. If "overlay", the violins are plotted over + one another, you might need to set "opacity" to see + them multiple violins. Has no effect on traces that + have "width" set. + waterfallgap + Sets the gap (in plot fraction) between bars of + adjacent location coordinates. + waterfallgroupgap + Sets the gap (in plot fraction) between bars of the + same location coordinate. + waterfallmode + Determines how bars at the same location coordinate are + displayed on the graph. With "group", the bars are + plotted next to one another centered around the shared + location. With "overlay", the bars are plotted over one + another, you might need to reduce "opacity" to see + multiple bars. + width + Sets the plot's width (in px). + xaxis + :class:`plotly.graph_objects.layout.XAxis` instance or + dict with compatible properties + yaxis + :class:`plotly.graph_objects.layout.YAxis` instance or + dict with compatible properties + + Returns + ------- + Layout + """ + super().__init__("layout") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + self._valid_props = { + "activeselection", + "activeshape", + "annotationdefaults", + "annotations", + "autosize", + "autotypenumbers", + "barcornerradius", + "bargap", + "bargroupgap", + "barmode", + "barnorm", + "boxgap", + "boxgroupgap", + "boxmode", + "calendar", + "clickmode", + "coloraxis", + "colorscale", + "colorway", + "computed", + "datarevision", + "dragmode", + "editrevision", + "extendfunnelareacolors", + "extendiciclecolors", + "extendpiecolors", + "extendsunburstcolors", + "extendtreemapcolors", + "font", + "funnelareacolorway", + "funnelgap", + "funnelgroupgap", + "funnelmode", + "geo", + "grid", + "height", + "hiddenlabels", + "hiddenlabelssrc", + "hidesources", + "hoverdistance", + "hoverlabel", + "hovermode", + "hoversubplots", + "iciclecolorway", + "imagedefaults", + "images", + "legend", + "map", + "mapbox", + "margin", + "meta", + "metasrc", + "minreducedheight", + "minreducedwidth", + "modebar", + "newselection", + "newshape", + "paper_bgcolor", + "piecolorway", + "plot_bgcolor", + "polar", + "scattergap", + "scattermode", + "scene", + "selectdirection", + "selectiondefaults", + "selectionrevision", + "selections", + "separators", + "shapedefaults", + "shapes", + "showlegend", + "sliderdefaults", + "sliders", + "smith", + "spikedistance", + "sunburstcolorway", + "template", + "ternary", + "title", + "transition", + "treemapcolorway", + "uirevision", + "uniformtext", + "updatemenudefaults", + "updatemenus", + "violingap", + "violingroupgap", + "violinmode", + "waterfallgap", + "waterfallgroupgap", + "waterfallmode", + "width", + "xaxis", + "yaxis", + } + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Layout +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Layout`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("activeselection", arg, activeselection) + self._set_property("activeshape", arg, activeshape) + self._set_property("annotations", arg, annotations) + self._set_property("annotationdefaults", arg, annotationdefaults) + self._set_property("autosize", arg, autosize) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("barcornerradius", arg, barcornerradius) + self._set_property("bargap", arg, bargap) + self._set_property("bargroupgap", arg, bargroupgap) + self._set_property("barmode", arg, barmode) + self._set_property("barnorm", arg, barnorm) + self._set_property("boxgap", arg, boxgap) + self._set_property("boxgroupgap", arg, boxgroupgap) + self._set_property("boxmode", arg, boxmode) + self._set_property("calendar", arg, calendar) + self._set_property("clickmode", arg, clickmode) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorway", arg, colorway) + self._set_property("computed", arg, computed) + self._set_property("datarevision", arg, datarevision) + self._set_property("dragmode", arg, dragmode) + self._set_property("editrevision", arg, editrevision) + self._set_property("extendfunnelareacolors", arg, extendfunnelareacolors) + self._set_property("extendiciclecolors", arg, extendiciclecolors) + self._set_property("extendpiecolors", arg, extendpiecolors) + self._set_property("extendsunburstcolors", arg, extendsunburstcolors) + self._set_property("extendtreemapcolors", arg, extendtreemapcolors) + self._set_property("font", arg, font) + self._set_property("funnelareacolorway", arg, funnelareacolorway) + self._set_property("funnelgap", arg, funnelgap) + self._set_property("funnelgroupgap", arg, funnelgroupgap) + self._set_property("funnelmode", arg, funnelmode) + self._set_property("geo", arg, geo) + self._set_property("grid", arg, grid) + self._set_property("height", arg, height) + self._set_property("hiddenlabels", arg, hiddenlabels) + self._set_property("hiddenlabelssrc", arg, hiddenlabelssrc) + self._set_property("hidesources", arg, hidesources) + self._set_property("hoverdistance", arg, hoverdistance) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovermode", arg, hovermode) + self._set_property("hoversubplots", arg, hoversubplots) + self._set_property("iciclecolorway", arg, iciclecolorway) + self._set_property("images", arg, images) + self._set_property("imagedefaults", arg, imagedefaults) + self._set_property("legend", arg, legend) + self._set_property("map", arg, map) + self._set_property("mapbox", arg, mapbox) + self._set_property("margin", arg, margin) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("minreducedheight", arg, minreducedheight) + self._set_property("minreducedwidth", arg, minreducedwidth) + self._set_property("modebar", arg, modebar) + self._set_property("newselection", arg, newselection) + self._set_property("newshape", arg, newshape) + self._set_property("paper_bgcolor", arg, paper_bgcolor) + self._set_property("piecolorway", arg, piecolorway) + self._set_property("plot_bgcolor", arg, plot_bgcolor) + self._set_property("polar", arg, polar) + self._set_property("scattergap", arg, scattergap) + self._set_property("scattermode", arg, scattermode) + self._set_property("scene", arg, scene) + self._set_property("selectdirection", arg, selectdirection) + self._set_property("selectionrevision", arg, selectionrevision) + self._set_property("selections", arg, selections) + self._set_property("selectiondefaults", arg, selectiondefaults) + self._set_property("separators", arg, separators) + self._set_property("shapes", arg, shapes) + self._set_property("shapedefaults", arg, shapedefaults) + self._set_property("showlegend", arg, showlegend) + self._set_property("sliders", arg, sliders) + self._set_property("sliderdefaults", arg, sliderdefaults) + self._set_property("smith", arg, smith) + self._set_property("spikedistance", arg, spikedistance) + self._set_property("sunburstcolorway", arg, sunburstcolorway) + self._set_property("template", arg, template) + self._set_property("ternary", arg, ternary) + self._set_property("title", arg, title) + self._set_property("transition", arg, transition) + self._set_property("treemapcolorway", arg, treemapcolorway) + self._set_property("uirevision", arg, uirevision) + self._set_property("uniformtext", arg, uniformtext) + self._set_property("updatemenus", arg, updatemenus) + self._set_property("updatemenudefaults", arg, updatemenudefaults) + self._set_property("violingap", arg, violingap) + self._set_property("violingroupgap", arg, violingroupgap) + self._set_property("violinmode", arg, violinmode) + self._set_property("waterfallgap", arg, waterfallgap) + self._set_property("waterfallgroupgap", arg, waterfallgroupgap) + self._set_property("waterfallmode", arg, waterfallmode) + self._set_property("width", arg, width) + self._set_property("xaxis", arg, xaxis) + self._set_property("yaxis", arg, yaxis) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_mesh3d.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_mesh3d.py new file mode 100644 index 0000000..68928a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_mesh3d.py @@ -0,0 +1,2577 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Mesh3d(_BaseTraceType): + _parent_path_str = "" + _path_str = "mesh3d" + _valid_props = { + "alphahull", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "contour", + "customdata", + "customdatasrc", + "delaunayaxis", + "facecolor", + "facecolorsrc", + "flatshading", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "i", + "ids", + "idssrc", + "intensity", + "intensitymode", + "intensitysrc", + "isrc", + "j", + "jsrc", + "k", + "ksrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lighting", + "lightposition", + "meta", + "metasrc", + "name", + "opacity", + "reversescale", + "scene", + "showlegend", + "showscale", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "vertexcolor", + "vertexcolorsrc", + "visible", + "x", + "xcalendar", + "xhoverformat", + "xsrc", + "y", + "ycalendar", + "yhoverformat", + "ysrc", + "z", + "zcalendar", + "zhoverformat", + "zsrc", + } + + @property + def alphahull(self): + """ + Determines how the mesh surface triangles are derived from the + set of vertices (points) represented by the `x`, `y` and `z` + arrays, if the `i`, `j`, `k` arrays are not supplied. For + general use of `mesh3d` it is preferred that `i`, `j`, `k` are + supplied. If "-1", Delaunay triangulation is used, which is + mainly suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In case the + `delaunayaxis` intersects the mesh surface at more than one + point it will result triangles that are very long in the + dimension of `delaunayaxis`. If ">0", the alpha-shape algorithm + is used. In this case, the positive `alphahull` value signals + the use of the alpha-shape algorithm, _and_ its value acts as + the parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or if the + intention is to enclose the `x`, `y` and `z` point set into a + convex hull. + + The 'alphahull' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["alphahull"] + + @alphahull.setter + def alphahull(self, val): + self["alphahull"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here `intensity`) or the bounds set + in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` + are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as `intensity` and if set, `cmin` must be set as + well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as `intensity`. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as `intensity` and if set, `cmax` must be set as + well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the color of the whole mesh + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to mesh3d.colorscale + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.mesh3d.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def contour(self): + """ + The 'contour' property is an instance of Contour + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.Contour` + - A dict of string/value properties that will be passed + to the Contour constructor + + Returns + ------- + plotly.graph_objs.mesh3d.Contour + """ + return self["contour"] + + @contour.setter + def contour(self, val): + self["contour"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def delaunayaxis(self): + """ + Sets the Delaunay axis, which is the axis that is perpendicular + to the surface of the Delaunay triangulation. It has an effect + if `i`, `j`, `k` are not provided and `alphahull` is set to + indicate Delaunay triangulation. + + The 'delaunayaxis' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['x', 'y', 'z'] + + Returns + ------- + Any + """ + return self["delaunayaxis"] + + @delaunayaxis.setter + def delaunayaxis(self, val): + self["delaunayaxis"] = val + + @property + def facecolor(self): + """ + Sets the color of each face Overrides "color" and + "vertexcolor". + + The 'facecolor' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["facecolor"] + + @facecolor.setter + def facecolor(self, val): + self["facecolor"] = val + + @property + def facecolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `facecolor`. + + The 'facecolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["facecolorsrc"] + + @facecolorsrc.setter + def facecolorsrc(self, val): + self["facecolorsrc"] = val + + @property + def flatshading(self): + """ + Determines whether or not normal smoothing is applied to the + meshes, creating meshes with an angular, low-poly look via flat + reflections. + + The 'flatshading' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["flatshading"] + + @flatshading.setter + def flatshading(self, val): + self["flatshading"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.mesh3d.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def i(self): + """ + A vector of vertex indices, i.e. integer values between 0 and + the length of the vertex vectors, representing the "first" + vertex of a triangle. For example, `{i[m], j[m], k[m]}` + together represent face m (triangle m) in the mesh, where `i[m] + = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex + arrays. Therefore, each element in `i` represents a point in + space, which is the first vertex of a triangle. + + The 'i' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["i"] + + @i.setter + def i(self, val): + self["i"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def intensity(self): + """ + Sets the intensity values for vertices or cells as defined by + `intensitymode`. It can be used for plotting fields on meshes. + + The 'intensity' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["intensity"] + + @intensity.setter + def intensity(self, val): + self["intensity"] = val + + @property + def intensitymode(self): + """ + Determines the source of `intensity` values. + + The 'intensitymode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['vertex', 'cell'] + + Returns + ------- + Any + """ + return self["intensitymode"] + + @intensitymode.setter + def intensitymode(self, val): + self["intensitymode"] = val + + @property + def intensitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `intensity`. + + The 'intensitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["intensitysrc"] + + @intensitysrc.setter + def intensitysrc(self, val): + self["intensitysrc"] = val + + @property + def isrc(self): + """ + Sets the source reference on Chart Studio Cloud for `i`. + + The 'isrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["isrc"] + + @isrc.setter + def isrc(self, val): + self["isrc"] = val + + @property + def j(self): + """ + A vector of vertex indices, i.e. integer values between 0 and + the length of the vertex vectors, representing the "second" + vertex of a triangle. For example, `{i[m], j[m], k[m]}` + together represent face m (triangle m) in the mesh, where `j[m] + = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex + arrays. Therefore, each element in `j` represents a point in + space, which is the second vertex of a triangle. + + The 'j' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["j"] + + @j.setter + def j(self, val): + self["j"] = val + + @property + def jsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `j`. + + The 'jsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["jsrc"] + + @jsrc.setter + def jsrc(self, val): + self["jsrc"] = val + + @property + def k(self): + """ + A vector of vertex indices, i.e. integer values between 0 and + the length of the vertex vectors, representing the "third" + vertex of a triangle. For example, `{i[m], j[m], k[m]}` + together represent face m (triangle m) in the mesh, where `k[m] + = n` points to the triplet `{x[n], y[n], z[n]}` in the vertex + arrays. Therefore, each element in `k` represents a point in + space, which is the third vertex of a triangle. + + The 'k' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["k"] + + @k.setter + def k(self, val): + self["k"] = val + + @property + def ksrc(self): + """ + Sets the source reference on Chart Studio Cloud for `k`. + + The 'ksrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ksrc"] + + @ksrc.setter + def ksrc(self, val): + self["ksrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.mesh3d.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.Lighting` + - A dict of string/value properties that will be passed + to the Lighting constructor + + Returns + ------- + plotly.graph_objs.mesh3d.Lighting + """ + return self["lighting"] + + @lighting.setter + def lighting(self, val): + self["lighting"] = val + + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.Lightposition` + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Returns + ------- + plotly.graph_objs.mesh3d.Lightposition + """ + return self["lightposition"] + + @lightposition.setter + def lightposition(self, val): + self["lightposition"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.mesh3d.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with the vertices. If trace + `hoverinfo` contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def vertexcolor(self): + """ + Sets the color of each vertex Overrides "color". While Red, + green and blue colors are in the range of 0 and 255; in the + case of having vertex color data in RGBA format, the alpha + color should be normalized to be between 0 and 1. + + The 'vertexcolor' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["vertexcolor"] + + @vertexcolor.setter + def vertexcolor(self, val): + self["vertexcolor"] = val + + @property + def vertexcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `vertexcolor`. + + The 'vertexcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["vertexcolorsrc"] + + @vertexcolorsrc.setter + def vertexcolorsrc(self, val): + self["vertexcolorsrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the X coordinates of the vertices. The nth element of + vectors `x`, `y` and `z` jointly represent the X, Y and Z + coordinates of the nth vertex. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the Y coordinates of the vertices. The nth element of + vectors `x`, `y` and `z` jointly represent the X, Y and Z + coordinates of the nth vertex. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the Z coordinates of the vertices. The nth element of + vectors `x`, `y` and `z` jointly represent the X, Y and Z + coordinates of the nth vertex. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zcalendar(self): + """ + Sets the calendar system to use with `z` date data. + + The 'zcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["zcalendar"] + + @zcalendar.setter + def zcalendar(self, val): + self["zcalendar"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + alphahull + Determines how the mesh surface triangles are derived + from the set of vertices (points) represented by the + `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays + are not supplied. For general use of `mesh3d` it is + preferred that `i`, `j`, `k` are supplied. If "-1", + Delaunay triangulation is used, which is mainly + suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In + case the `delaunayaxis` intersects the mesh surface at + more than one point it will result triangles that are + very long in the dimension of `delaunayaxis`. If ">0", + the alpha-shape algorithm is used. In this case, the + positive `alphahull` value signals the use of the + alpha-shape algorithm, _and_ its value acts as the + parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or + if the intention is to enclose the `x`, `y` and `z` + point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `intensity`) or + the bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `intensity` and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `intensity`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `intensity` and if set, `cmax` + must be set as well. + color + Sets the color of the whole mesh + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delaunayaxis + Sets the Delaunay axis, which is the axis that is + perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, `k` are + not provided and `alphahull` is set to indicate + Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" and + "vertexcolor". + facecolorsrc + Sets the source reference on Chart Studio Cloud for + `facecolor`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + i + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "first" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `i[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in space, which + is the first vertex of a triangle. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + intensity + Sets the intensity values for vertices or cells as + defined by `intensitymode`. It can be used for plotting + fields on meshes. + intensitymode + Determines the source of `intensity` values. + intensitysrc + Sets the source reference on Chart Studio Cloud for + `intensity`. + isrc + Sets the source reference on Chart Studio Cloud for + `i`. + j + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "second" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `j[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in space, which + is the second vertex of a triangle. + jsrc + Sets the source reference on Chart Studio Cloud for + `j`. + k + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "third" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `k[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in space, which + is the third vertex of a triangle. + ksrc + Sets the source reference on Chart Studio Cloud for + `k`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.mesh3d.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides "color". While + Red, green and blue colors are in the range of 0 and + 255; in the case of having vertex color data in RGBA + format, the alpha color should be normalized to be + between 0 and 1. + vertexcolorsrc + Sets the source reference on Chart Studio Cloud for + `vertexcolor`. + 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). + x + Sets the X coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + alphahull=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + delaunayaxis=None, + facecolor=None, + facecolorsrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + i=None, + ids=None, + idssrc=None, + intensity=None, + intensitymode=None, + intensitysrc=None, + isrc=None, + j=None, + jsrc=None, + k=None, + ksrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + vertexcolor=None, + vertexcolorsrc=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Mesh3d object + + Draws sets of triangles with coordinates given by three + 1-dimensional arrays in `x`, `y`, `z` and (1) a sets of `i`, + `j`, `k` indices (2) Delaunay triangulation or (3) the Alpha- + shape algorithm or (4) the Convex-hull algorithm + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Mesh3d` + alphahull + Determines how the mesh surface triangles are derived + from the set of vertices (points) represented by the + `x`, `y` and `z` arrays, if the `i`, `j`, `k` arrays + are not supplied. For general use of `mesh3d` it is + preferred that `i`, `j`, `k` are supplied. If "-1", + Delaunay triangulation is used, which is mainly + suitable if the mesh is a single, more or less layer + surface that is perpendicular to `delaunayaxis`. In + case the `delaunayaxis` intersects the mesh surface at + more than one point it will result triangles that are + very long in the dimension of `delaunayaxis`. If ">0", + the alpha-shape algorithm is used. In this case, the + positive `alphahull` value signals the use of the + alpha-shape algorithm, _and_ its value acts as the + parameter for the mesh fitting. If 0, the convex-hull + algorithm is used. It is suitable for convex bodies or + if the intention is to enclose the `x`, `y` and `z` + point set into a convex hull. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `intensity`) or + the bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `intensity` and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `intensity`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `intensity` and if set, `cmax` + must be set as well. + color + Sets the color of the whole mesh + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.mesh3d.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.mesh3d.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + delaunayaxis + Sets the Delaunay axis, which is the axis that is + perpendicular to the surface of the Delaunay + triangulation. It has an effect if `i`, `j`, `k` are + not provided and `alphahull` is set to indicate + Delaunay triangulation. + facecolor + Sets the color of each face Overrides "color" and + "vertexcolor". + facecolorsrc + Sets the source reference on Chart Studio Cloud for + `facecolor`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.mesh3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + i + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "first" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `i[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `i` represents a point in space, which + is the first vertex of a triangle. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + intensity + Sets the intensity values for vertices or cells as + defined by `intensitymode`. It can be used for plotting + fields on meshes. + intensitymode + Determines the source of `intensity` values. + intensitysrc + Sets the source reference on Chart Studio Cloud for + `intensity`. + isrc + Sets the source reference on Chart Studio Cloud for + `i`. + j + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "second" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `j[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `j` represents a point in space, which + is the second vertex of a triangle. + jsrc + Sets the source reference on Chart Studio Cloud for + `j`. + k + A vector of vertex indices, i.e. integer values between + 0 and the length of the vertex vectors, representing + the "third" vertex of a triangle. For example, `{i[m], + j[m], k[m]}` together represent face m (triangle m) in + the mesh, where `k[m] = n` points to the triplet + `{x[n], y[n], z[n]}` in the vertex arrays. Therefore, + each element in `k` represents a point in space, which + is the third vertex of a triangle. + ksrc + Sets the source reference on Chart Studio Cloud for + `k`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.mesh3d.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.mesh3d.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.mesh3d.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.mesh3d.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + vertexcolor + Sets the color of each vertex Overrides "color". While + Red, green and blue colors are in the range of 0 and + 255; in the case of having vertex color data in RGBA + format, the alpha color should be normalized to be + between 0 and 1. + vertexcolorsrc + Sets the source reference on Chart Studio Cloud for + `vertexcolor`. + 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). + x + Sets the X coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices. The nth element + of vectors `x`, `y` and `z` jointly represent the X, Y + and Z coordinates of the nth vertex. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Mesh3d + """ + super().__init__("mesh3d") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Mesh3d +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Mesh3d`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alphahull", arg, alphahull) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("contour", arg, contour) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("delaunayaxis", arg, delaunayaxis) + self._set_property("facecolor", arg, facecolor) + self._set_property("facecolorsrc", arg, facecolorsrc) + self._set_property("flatshading", arg, flatshading) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("i", arg, i) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("intensity", arg, intensity) + self._set_property("intensitymode", arg, intensitymode) + self._set_property("intensitysrc", arg, intensitysrc) + self._set_property("isrc", arg, isrc) + self._set_property("j", arg, j) + self._set_property("jsrc", arg, jsrc) + self._set_property("k", arg, k) + self._set_property("ksrc", arg, ksrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lighting", arg, lighting) + self._set_property("lightposition", arg, lightposition) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("vertexcolor", arg, vertexcolor) + self._set_property("vertexcolorsrc", arg, vertexcolorsrc) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zcalendar", arg, zcalendar) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "mesh3d" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_ohlc.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_ohlc.py new file mode 100644 index 0000000..26f405a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_ohlc.py @@ -0,0 +1,1675 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Ohlc(_BaseTraceType): + _parent_path_str = "" + _path_str = "ohlc" + _valid_props = { + "close", + "closesrc", + "customdata", + "customdatasrc", + "decreasing", + "high", + "highsrc", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "increasing", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "low", + "lowsrc", + "meta", + "metasrc", + "name", + "opacity", + "open", + "opensrc", + "selectedpoints", + "showlegend", + "stream", + "text", + "textsrc", + "tickwidth", + "type", + "uid", + "uirevision", + "visible", + "x", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "yaxis", + "yhoverformat", + "zorder", + } + + @property + def close(self): + """ + Sets the close values. + + The 'close' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["close"] + + @close.setter + def close(self, val): + self["close"] = val + + @property + def closesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `close`. + + The 'closesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["closesrc"] + + @closesrc.setter + def closesrc(self, val): + self["closesrc"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def decreasing(self): + """ + The 'decreasing' property is an instance of Decreasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.Decreasing` + - A dict of string/value properties that will be passed + to the Decreasing constructor + + Returns + ------- + plotly.graph_objs.ohlc.Decreasing + """ + return self["decreasing"] + + @decreasing.setter + def decreasing(self, val): + self["decreasing"] = val + + @property + def high(self): + """ + Sets the high values. + + The 'high' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["high"] + + @high.setter + def high(self, val): + self["high"] = val + + @property + def highsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `high`. + + The 'highsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["highsrc"] + + @highsrc.setter + def highsrc(self, val): + self["highsrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.ohlc.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def increasing(self): + """ + The 'increasing' property is an instance of Increasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.Increasing` + - A dict of string/value properties that will be passed + to the Increasing constructor + + Returns + ------- + plotly.graph_objs.ohlc.Increasing + """ + return self["increasing"] + + @increasing.setter + def increasing(self, val): + self["increasing"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.ohlc.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.ohlc.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def low(self): + """ + Sets the low values. + + The 'low' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["low"] + + @low.setter + def low(self, val): + self["low"] = val + + @property + def lowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `low`. + + The 'lowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lowsrc"] + + @lowsrc.setter + def lowsrc(self, val): + self["lowsrc"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def open(self): + """ + Sets the open values. + + The 'open' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["open"] + + @open.setter + def open(self, val): + self["open"] = val + + @property + def opensrc(self): + """ + Sets the source reference on Chart Studio Cloud for `open`. + + The 'opensrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opensrc"] + + @opensrc.setter + def opensrc(self, val): + self["opensrc"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.ohlc.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets hover text elements associated with each sample point. If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + this trace's sample points. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def tickwidth(self): + """ + Sets the width of the open/close tick marks relative to the "x" + minimal interval. + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, 0.5] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. If absent, linear coordinate will be + generated. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.ohlc.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + tickwidth + Sets the width of the open/close tick marks relative to + the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + close=None, + closesrc=None, + customdata=None, + customdatasrc=None, + decreasing=None, + high=None, + highsrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + low=None, + lowsrc=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + open=None, + opensrc=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textsrc=None, + tickwidth=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + yaxis=None, + yhoverformat=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Ohlc object + + The ohlc (short for Open-High-Low-Close) is a style of + financial chart describing open, high, low and close for a + given `x` coordinate (most likely time). The tip of the lines + represent the `low` and `high` values and the horizontal + segments represent the `open` and `close` values. Sample points + where the close value is higher (lower) then the open value are + called increasing (decreasing). By default, increasing items + are drawn in green whereas decreasing are drawn in red. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Ohlc` + close + Sets the close values. + closesrc + Sets the source reference on Chart Studio Cloud for + `close`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.ohlc.Decreasing` instance + or dict with compatible properties + high + Sets the high values. + highsrc + Sets the source reference on Chart Studio Cloud for + `high`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.ohlc.Hoverlabel` instance + or dict with compatible properties + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.ohlc.Increasing` instance + or dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.ohlc.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.ohlc.Line` instance or + dict with compatible properties + low + Sets the low values. + lowsrc + Sets the source reference on Chart Studio Cloud for + `low`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + open + Sets the open values. + opensrc + Sets the source reference on Chart Studio Cloud for + `open`. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.ohlc.Stream` instance or + dict with compatible properties + text + Sets hover text elements associated with each sample + point. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to this trace's sample points. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + tickwidth + Sets the width of the open/close tick marks relative to + the "x" minimal interval. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. If absent, linear coordinate + will be generated. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Ohlc + """ + super().__init__("ohlc") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Ohlc +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Ohlc`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("close", arg, close) + self._set_property("closesrc", arg, closesrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("decreasing", arg, decreasing) + self._set_property("high", arg, high) + self._set_property("highsrc", arg, highsrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("increasing", arg, increasing) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("low", arg, low) + self._set_property("lowsrc", arg, lowsrc) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("open", arg, open) + self._set_property("opensrc", arg, opensrc) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("yaxis", arg, yaxis) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "ohlc" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_parcats.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_parcats.py new file mode 100644 index 0000000..bea3d95 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_parcats.py @@ -0,0 +1,934 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Parcats(_BaseTraceType): + _parent_path_str = "" + _path_str = "parcats" + _valid_props = { + "arrangement", + "bundlecolors", + "counts", + "countssrc", + "dimensiondefaults", + "dimensions", + "domain", + "hoverinfo", + "hoveron", + "hovertemplate", + "labelfont", + "legendgrouptitle", + "legendwidth", + "line", + "meta", + "metasrc", + "name", + "sortpaths", + "stream", + "tickfont", + "type", + "uid", + "uirevision", + "visible", + } + + @property + def arrangement(self): + """ + Sets the drag interaction mode for categories and dimensions. + If `perpendicular`, the categories can only move along a line + perpendicular to the paths. If `freeform`, the categories can + freely move on the plane. If `fixed`, the categories and + dimensions are stationary. + + The 'arrangement' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['perpendicular', 'freeform', 'fixed'] + + Returns + ------- + Any + """ + return self["arrangement"] + + @arrangement.setter + def arrangement(self, val): + self["arrangement"] = val + + @property + def bundlecolors(self): + """ + Sort paths so that like colors are bundled together within each + category. + + The 'bundlecolors' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["bundlecolors"] + + @bundlecolors.setter + def bundlecolors(self, val): + self["bundlecolors"] = val + + @property + def counts(self): + """ + The number of observations represented by each state. Defaults + to 1 so that each state represents one observation + + The 'counts' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["counts"] + + @counts.setter + def counts(self, val): + self["counts"] = val + + @property + def countssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `counts`. + + The 'countssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["countssrc"] + + @countssrc.setter + def countssrc(self, val): + self["countssrc"] = val + + @property + def dimensions(self): + """ + The dimensions (variables) of the parallel categories diagram. + + The 'dimensions' property is a tuple of instances of + Dimension that may be specified as: + - A list or tuple of instances of plotly.graph_objs.parcats.Dimension + - A list or tuple of dicts of string/value properties that + will be passed to the Dimension constructor + + Returns + ------- + tuple[plotly.graph_objs.parcats.Dimension] + """ + return self["dimensions"] + + @dimensions.setter + def dimensions(self, val): + self["dimensions"] = val + + @property + def dimensiondefaults(self): + """ + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets the + default property values to use for elements of + parcats.dimensions + + The 'dimensiondefaults' property is an instance of Dimension + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Dimension` + - A dict of string/value properties that will be passed + to the Dimension constructor + + Returns + ------- + plotly.graph_objs.parcats.Dimension + """ + return self["dimensiondefaults"] + + @dimensiondefaults.setter + def dimensiondefaults(self, val): + self["dimensiondefaults"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.parcats.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['count', 'probability'] joined with '+' characters + (e.g. 'count+probability') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + + Returns + ------- + Any + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoveron(self): + """ + Sets the hover interaction mode for the parcats diagram. If + `category`, hover interaction take place per category. If + `color`, hover interactions take place per color per category. + If `dimension`, hover interactions take place across all + categories per dimension. + + The 'hoveron' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['category', 'color', 'dimension'] + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. This value + here applies when hovering over dimensions. Note that + `*categorycount`, "colorcount" and "bandcolorcount" are only + available when `hoveron` contains the "color" flagFinally, the + template string has access to variables `count`, `probability`, + `category`, `categorycount`, `colorcount` and `bandcolorcount`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def labelfont(self): + """ + Sets the font for the `dimension` labels. + + The 'labelfont' property is an instance of Labelfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Labelfont` + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Returns + ------- + plotly.graph_objs.parcats.Labelfont + """ + return self["labelfont"] + + @labelfont.setter + def labelfont(self, val): + self["labelfont"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.parcats.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.parcats.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def sortpaths(self): + """ + Sets the path sorting algorithm. If `forward`, sort paths based + on dimension categories from left to right. If `backward`, sort + paths based on dimensions categories from right to left. + + The 'sortpaths' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['forward', 'backward'] + + Returns + ------- + Any + """ + return self["sortpaths"] + + @sortpaths.setter + def sortpaths(self, val): + self["sortpaths"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.parcats.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def tickfont(self): + """ + Sets the font for the `category` labels. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.parcats.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + arrangement + Sets the drag interaction mode for categories and + dimensions. If `perpendicular`, the categories can only + move along a line perpendicular to the paths. If + `freeform`, the categories can freely move on the + plane. If `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled together + within each category. + counts + The number of observations represented by each state. + Defaults to 1 so that each state represents one + observation + countssrc + Sets the source reference on Chart Studio Cloud for + `counts`. + dimensions + The dimensions (variables) of the parallel categories + diagram. + dimensiondefaults + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets + the default property values to use for elements of + parcats.dimensions + domain + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take place + per category. If `color`, hover interactions take place + per color per category. If `dimension`, hover + interactions take place across all categories per + dimension. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. This value here applies when hovering + over dimensions. Note that `*categorycount`, + "colorcount" and "bandcolorcount" are only available + when `hoveron` contains the "color" flagFinally, the + template string has access to variables `count`, + `probability`, `category`, `categorycount`, + `colorcount` and `bandcolorcount`. Anything contained + in tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + labelfont + Sets the font for the `dimension` labels. + legendgrouptitle + :class:`plotly.graph_objects.parcats.Legendgrouptitle` + instance or dict with compatible properties + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, sort + paths based on dimension categories from left to right. + If `backward`, sort paths based on dimensions + categories from right to left. + stream + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + """ + + def __init__( + self, + arg=None, + arrangement=None, + bundlecolors=None, + counts=None, + countssrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + hoverinfo=None, + hoveron=None, + hovertemplate=None, + labelfont=None, + legendgrouptitle=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + sortpaths=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + visible=None, + **kwargs, + ): + """ + Construct a new Parcats object + + Parallel categories diagram for multidimensional categorical + data. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Parcats` + arrangement + Sets the drag interaction mode for categories and + dimensions. If `perpendicular`, the categories can only + move along a line perpendicular to the paths. If + `freeform`, the categories can freely move on the + plane. If `fixed`, the categories and dimensions are + stationary. + bundlecolors + Sort paths so that like colors are bundled together + within each category. + counts + The number of observations represented by each state. + Defaults to 1 so that each state represents one + observation + countssrc + Sets the source reference on Chart Studio Cloud for + `counts`. + dimensions + The dimensions (variables) of the parallel categories + diagram. + dimensiondefaults + When used in a template (as + layout.template.data.parcats.dimensiondefaults), sets + the default property values to use for elements of + parcats.dimensions + domain + :class:`plotly.graph_objects.parcats.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoveron + Sets the hover interaction mode for the parcats + diagram. If `category`, hover interaction take place + per category. If `color`, hover interactions take place + per color per category. If `dimension`, hover + interactions take place across all categories per + dimension. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. This value here applies when hovering + over dimensions. Note that `*categorycount`, + "colorcount" and "bandcolorcount" are only available + when `hoveron` contains the "color" flagFinally, the + template string has access to variables `count`, + `probability`, `category`, `categorycount`, + `colorcount` and `bandcolorcount`. Anything contained + in tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + labelfont + Sets the font for the `dimension` labels. + legendgrouptitle + :class:`plotly.graph_objects.parcats.Legendgrouptitle` + instance or dict with compatible properties + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcats.Line` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + sortpaths + Sets the path sorting algorithm. If `forward`, sort + paths based on dimension categories from left to right. + If `backward`, sort paths based on dimensions + categories from right to left. + stream + :class:`plotly.graph_objects.parcats.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `category` labels. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + + Returns + ------- + Parcats + """ + super().__init__("parcats") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Parcats +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Parcats`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("arrangement", arg, arrangement) + self._set_property("bundlecolors", arg, bundlecolors) + self._set_property("counts", arg, counts) + self._set_property("countssrc", arg, countssrc) + self._set_property("dimensions", arg, dimensions) + self._set_property("dimensiondefaults", arg, dimensiondefaults) + self._set_property("domain", arg, domain) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("labelfont", arg, labelfont) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("sortpaths", arg, sortpaths) + self._set_property("stream", arg, stream) + self._set_property("tickfont", arg, tickfont) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + + self._props["type"] = "parcats" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_parcoords.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_parcoords.py new file mode 100644 index 0000000..e3f2f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_parcoords.py @@ -0,0 +1,919 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Parcoords(_BaseTraceType): + _parent_path_str = "" + _path_str = "parcoords" + _valid_props = { + "customdata", + "customdatasrc", + "dimensiondefaults", + "dimensions", + "domain", + "ids", + "idssrc", + "labelangle", + "labelfont", + "labelside", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "meta", + "metasrc", + "name", + "rangefont", + "stream", + "tickfont", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dimensions(self): + """ + The dimensions (variables) of the parallel coordinates chart. + 2..60 dimensions are supported. + + The 'dimensions' property is a tuple of instances of + Dimension that may be specified as: + - A list or tuple of instances of plotly.graph_objs.parcoords.Dimension + - A list or tuple of dicts of string/value properties that + will be passed to the Dimension constructor + + Returns + ------- + tuple[plotly.graph_objs.parcoords.Dimension] + """ + return self["dimensions"] + + @dimensions.setter + def dimensions(self, val): + self["dimensions"] = val + + @property + def dimensiondefaults(self): + """ + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets the + default property values to use for elements of + parcoords.dimensions + + The 'dimensiondefaults' property is an instance of Dimension + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Dimension` + - A dict of string/value properties that will be passed + to the Dimension constructor + + Returns + ------- + plotly.graph_objs.parcoords.Dimension + """ + return self["dimensiondefaults"] + + @dimensiondefaults.setter + def dimensiondefaults(self, val): + self["dimensiondefaults"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.parcoords.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def labelangle(self): + """ + Sets the angle of the labels with respect to the horizontal. + For example, a `tickangle` of -90 draws the labels vertically. + Tilted labels with "labelangle" may be positioned better inside + margins when `labelposition` is set to "bottom". + + The 'labelangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["labelangle"] + + @labelangle.setter + def labelangle(self, val): + self["labelangle"] = val + + @property + def labelfont(self): + """ + Sets the font for the `dimension` labels. + + The 'labelfont' property is an instance of Labelfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Labelfont` + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Returns + ------- + plotly.graph_objs.parcoords.Labelfont + """ + return self["labelfont"] + + @labelfont.setter + def labelfont(self, val): + self["labelfont"] = val + + @property + def labelside(self): + """ + Specifies the location of the `label`. "top" positions labels + above, next to the title "bottom" positions labels below the + graph Tilted labels with "labelangle" may be positioned better + inside margins when `labelposition` is set to "bottom". + + The 'labelside' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom'] + + Returns + ------- + Any + """ + return self["labelside"] + + @labelside.setter + def labelside(self, val): + self["labelside"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.parcoords.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.parcoords.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def rangefont(self): + """ + Sets the font for the `dimension` range values. + + The 'rangefont' property is an instance of Rangefont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Rangefont` + - A dict of string/value properties that will be passed + to the Rangefont constructor + + Returns + ------- + plotly.graph_objs.parcoords.Rangefont + """ + return self["rangefont"] + + @rangefont.setter + def rangefont(self, val): + self["rangefont"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.parcoords.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def tickfont(self): + """ + Sets the font for the `dimension` tick values. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.parcoords.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.parcoords.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dimensions + The dimensions (variables) of the parallel coordinates + chart. 2..60 dimensions are supported. + dimensiondefaults + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets + the default property values to use for elements of + parcoords.dimensions + domain + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + labelangle + Sets the angle of the labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + labels vertically. Tilted labels with "labelangle" may + be positioned better inside margins when + `labelposition` is set to "bottom". + labelfont + Sets the font for the `dimension` labels. + labelside + Specifies the location of the `label`. "top" positions + labels above, next to the title "bottom" positions + labels below the graph Tilted labels with "labelangle" + may be positioned better inside margins when + `labelposition` is set to "bottom". + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.parcoords.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + rangefont + Sets the font for the `dimension` range values. + stream + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.parcoords.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + dimensions=None, + dimensiondefaults=None, + domain=None, + ids=None, + idssrc=None, + labelangle=None, + labelfont=None, + labelside=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + meta=None, + metasrc=None, + name=None, + rangefont=None, + stream=None, + tickfont=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Parcoords object + + Parallel coordinates for multidimensional exploratory data + analysis. The samples are specified in `dimensions`. The colors + are set in `line.color`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Parcoords` + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dimensions + The dimensions (variables) of the parallel coordinates + chart. 2..60 dimensions are supported. + dimensiondefaults + When used in a template (as + layout.template.data.parcoords.dimensiondefaults), sets + the default property values to use for elements of + parcoords.dimensions + domain + :class:`plotly.graph_objects.parcoords.Domain` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + labelangle + Sets the angle of the labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + labels vertically. Tilted labels with "labelangle" may + be positioned better inside margins when + `labelposition` is set to "bottom". + labelfont + Sets the font for the `dimension` labels. + labelside + Specifies the location of the `label`. "top" positions + labels above, next to the title "bottom" positions + labels below the graph Tilted labels with "labelangle" + may be positioned better inside margins when + `labelposition` is set to "bottom". + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.parcoords.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.parcoords.Line` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + rangefont + Sets the font for the `dimension` range values. + stream + :class:`plotly.graph_objects.parcoords.Stream` instance + or dict with compatible properties + tickfont + Sets the font for the `dimension` tick values. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.parcoords.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Parcoords + """ + super().__init__("parcoords") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Parcoords +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Parcoords`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dimensions", arg, dimensions) + self._set_property("dimensiondefaults", arg, dimensiondefaults) + self._set_property("domain", arg, domain) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("labelangle", arg, labelangle) + self._set_property("labelfont", arg, labelfont) + self._set_property("labelside", arg, labelside) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("rangefont", arg, rangefont) + self._set_property("stream", arg, stream) + self._set_property("tickfont", arg, tickfont) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "parcoords" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_pie.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_pie.py new file mode 100644 index 0000000..f2eda4a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_pie.py @@ -0,0 +1,1869 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Pie(_BaseTraceType): + _parent_path_str = "" + _path_str = "pie" + _valid_props = { + "automargin", + "customdata", + "customdatasrc", + "direction", + "dlabel", + "domain", + "hole", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextfont", + "insidetextorientation", + "label0", + "labels", + "labelssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "opacity", + "outsidetextfont", + "pull", + "pullsrc", + "rotation", + "scalegroup", + "showlegend", + "sort", + "stream", + "text", + "textfont", + "textinfo", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "title", + "type", + "uid", + "uirevision", + "values", + "valuessrc", + "visible", + } + + @property + def automargin(self): + """ + Determines whether outside text labels can push the margins. + + The 'automargin' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["automargin"] + + @automargin.setter + def automargin(self, val): + self["automargin"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def direction(self): + """ + Specifies the direction at which succeeding sectors follow one + another. + + The 'direction' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['clockwise', 'counterclockwise'] + + Returns + ------- + Any + """ + return self["direction"] + + @direction.setter + def direction(self, val): + self["direction"] = val + + @property + def dlabel(self): + """ + Sets the label step. See `label0` for more info. + + The 'dlabel' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dlabel"] + + @dlabel.setter + def dlabel(self, val): + self["dlabel"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.pie.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hole(self): + """ + Sets the fraction of the radius to cut out of the pie. Use this + to make a donut chart. + + The 'hole' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["hole"] + + @hole.setter + def hole(self, val): + self["hole"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'percent', 'name'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.pie.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `label`, `color`, + `value`, `percent` and `text`. Anything contained in tag + `` is displayed in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each sector. If a + single string, the same string appears for all data points. If + an array of string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` must contain a + "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `textinfo` lying inside the sector. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.pie.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def insidetextorientation(self): + """ + Controls the orientation of the text inside chart sectors. When + set to "auto", text may be oriented in any direction in order + to be as big as possible in the middle of a sector. The + "horizontal" option orients text to be parallel with the bottom + of the chart, and may make text smaller in order to achieve + that goal. The "radial" option orients text along the radius of + the sector. The "tangential" option orients text perpendicular + to the radius of the sector. + + The 'insidetextorientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['horizontal', 'radial', 'tangential', 'auto'] + + Returns + ------- + Any + """ + return self["insidetextorientation"] + + @insidetextorientation.setter + def insidetextorientation(self, val): + self["insidetextorientation"] = val + + @property + def label0(self): + """ + Alternate to `labels`. Builds a numeric set of labels. Use with + `dlabel` where `label0` is the starting label and `dlabel` the + step. + + The 'label0' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["label0"] + + @label0.setter + def label0(self, val): + self["label0"] = val + + @property + def labels(self): + """ + Sets the sector labels. If `labels` entries are duplicated, we + sum associated `values` or simply count occurrences if `values` + is not provided. For other array attributes (including color) + we use the first non-empty entry among all occurrences of the + label. + + The 'labels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["labels"] + + @labels.setter + def labels(self, val): + self["labels"] = val + + @property + def labelssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `labels`. + + The 'labelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelssrc"] + + @labelssrc.setter + def labelssrc(self, val): + self["labelssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.pie.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.pie.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `textinfo` lying outside the sector. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.pie.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def pull(self): + """ + Sets the fraction of larger radius to pull the sectors out from + the center. This can be a constant to pull all slices apart + from each other equally or an array to highlight one or more + slices. + + The 'pull' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["pull"] + + @pull.setter + def pull(self, val): + self["pull"] = val + + @property + def pullsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `pull`. + + The 'pullsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["pullsrc"] + + @pullsrc.setter + def pullsrc(self, val): + self["pullsrc"] = val + + @property + def rotation(self): + """ + Instead of the first slice starting at 12 o'clock, rotate to + some other angle. + + The 'rotation' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["rotation"] + + @rotation.setter + def rotation(self, val): + self["rotation"] = val + + @property + def scalegroup(self): + """ + If there are multiple pie charts that should be sized according + to their totals, link them by providing a non-empty group id + here shared by every trace in the same group. + + The 'scalegroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["scalegroup"] + + @scalegroup.setter + def scalegroup(self, val): + self["scalegroup"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def sort(self): + """ + Determines whether or not the sectors are reordered from + largest to smallest. + + The 'sort' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["sort"] + + @sort.setter + def sort(self, val): + self["sort"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.pie.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each sector. If trace + `textinfo` contains a "text" flag, these elements will be seen + on the chart. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the font used for `textinfo`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.pie.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'percent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textposition(self): + """ + Specifies the location of the `textinfo`. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'auto', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `label`, + `color`, `value`, `percent` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.pie.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def values(self): + """ + Sets the values of the sectors. If omitted, we count + occurrences of each label. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + automargin + Determines whether outside text labels can push the + margins. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + direction + Specifies the direction at which succeeding sectors + follow one another. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties + hole + Sets the fraction of the radius to cut out of the pie. + Use this to make a donut chart. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.pie.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. + pull + Sets the fraction of larger radius to pull the sectors + out from the center. This can be a constant to pull all + slices apart from each other equally or an array to + highlight one or more slices. + pullsrc + Sets the source reference on Chart Studio Cloud for + `pull`. + rotation + Instead of the first slice starting at 12 o'clock, + rotate to some other angle. + scalegroup + If there are multiple pie charts that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + """ + + def __init__( + self, + arg=None, + automargin=None, + customdata=None, + customdatasrc=None, + direction=None, + dlabel=None, + domain=None, + hole=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + insidetextorientation=None, + label0=None, + labels=None, + labelssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + pull=None, + pullsrc=None, + rotation=None, + scalegroup=None, + showlegend=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + title=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Pie object + + A data visualized by the sectors of the pie is set in `values`. + The sector labels are set in `labels`. The sector colors are + set in `marker.colors` + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Pie` + automargin + Determines whether outside text labels can push the + margins. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + direction + Specifies the direction at which succeeding sectors + follow one another. + dlabel + Sets the label step. See `label0` for more info. + domain + :class:`plotly.graph_objects.pie.Domain` instance or + dict with compatible properties + hole + Sets the fraction of the radius to cut out of the pie. + Use this to make a donut chart. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.pie.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + label0 + Alternate to `labels`. Builds a numeric set of labels. + Use with `dlabel` where `label0` is the starting label + and `dlabel` the step. + labels + Sets the sector labels. If `labels` entries are + duplicated, we sum associated `values` or simply count + occurrences if `values` is not provided. For other + array attributes (including color) we use the first + non-empty entry among all occurrences of the label. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.pie.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.pie.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. + pull + Sets the fraction of larger radius to pull the sectors + out from the center. This can be a constant to pull all + slices apart from each other equally or an array to + highlight one or more slices. + pullsrc + Sets the source reference on Chart Studio Cloud for + `pull`. + rotation + Instead of the first slice starting at 12 o'clock, + rotate to some other angle. + scalegroup + If there are multiple pie charts that should be sized + according to their totals, link them by providing a + non-empty group id here shared by every trace in the + same group. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.pie.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Specifies the location of the `textinfo`. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `label`, `color`, `value`, `percent` and + `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + title + :class:`plotly.graph_objects.pie.Title` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values of the sectors. If omitted, we count + occurrences of each label. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + + Returns + ------- + Pie + """ + super().__init__("pie") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Pie +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Pie`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("automargin", arg, automargin) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("direction", arg, direction) + self._set_property("dlabel", arg, dlabel) + self._set_property("domain", arg, domain) + self._set_property("hole", arg, hole) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("insidetextorientation", arg, insidetextorientation) + self._set_property("label0", arg, label0) + self._set_property("labels", arg, labels) + self._set_property("labelssrc", arg, labelssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("pull", arg, pull) + self._set_property("pullsrc", arg, pullsrc) + self._set_property("rotation", arg, rotation) + self._set_property("scalegroup", arg, scalegroup) + self._set_property("showlegend", arg, showlegend) + self._set_property("sort", arg, sort) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("title", arg, title) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + + self._props["type"] = "pie" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_sankey.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_sankey.py new file mode 100644 index 0000000..0190fcf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_sankey.py @@ -0,0 +1,966 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Sankey(_BaseTraceType): + _parent_path_str = "" + _path_str = "sankey" + _valid_props = { + "arrangement", + "customdata", + "customdatasrc", + "domain", + "hoverinfo", + "hoverlabel", + "ids", + "idssrc", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "link", + "meta", + "metasrc", + "name", + "node", + "orientation", + "selectedpoints", + "stream", + "textfont", + "type", + "uid", + "uirevision", + "valueformat", + "valuesuffix", + "visible", + } + + @property + def arrangement(self): + """ + If value is `snap` (the default), the node arrangement is + assisted by automatic snapping of elements to preserve space + between nodes specified via `nodepad`. If value is + `perpendicular`, the nodes can only move along a line + perpendicular to the flow. If value is `freeform`, the nodes + can freely move on the plane. If value is `fixed`, the nodes + are stationary. + + The 'arrangement' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['snap', 'perpendicular', 'freeform', 'fixed'] + + Returns + ------- + Any + """ + return self["arrangement"] + + @arrangement.setter + def arrangement(self, val): + self["arrangement"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.sankey.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + Note that this attribute is superseded by `node.hoverinfo` and + `node.hoverinfo` for nodes and links respectively. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of [] joined with '+' characters + (e.g. '') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + + Returns + ------- + Any + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.sankey.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.sankey.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def link(self): + """ + The links of the Sankey plot. + + The 'link' property is an instance of Link + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Link` + - A dict of string/value properties that will be passed + to the Link constructor + + Returns + ------- + plotly.graph_objs.sankey.Link + """ + return self["link"] + + @link.setter + def link(self, val): + self["link"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def node(self): + """ + The nodes of the Sankey plot. + + The 'node' property is an instance of Node + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Node` + - A dict of string/value properties that will be passed + to the Node constructor + + Returns + ------- + plotly.graph_objs.sankey.Node + """ + return self["node"] + + @node.setter + def node(self, val): + self["node"] = val + + @property + def orientation(self): + """ + Sets the orientation of the Sankey diagram. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.sankey.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def textfont(self): + """ + Sets the font for node labels + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.sankey.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def valueformat(self): + """ + Sets the value formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'valueformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["valueformat"] + + @valueformat.setter + def valueformat(self, val): + self["valueformat"] = val + + @property + def valuesuffix(self): + """ + Adds a unit to follow the value in the hover tooltip. Add a + space if a separation is necessary from the value. + + The 'valuesuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["valuesuffix"] + + @valuesuffix.setter + def valuesuffix(self, val): + self["valuesuffix"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + arrangement + If value is `snap` (the default), the node arrangement + is assisted by automatic snapping of elements to + preserve space between nodes specified via `nodepad`. + If value is `perpendicular`, the nodes can only move + along a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the plane. If + value is `fixed`, the nodes are stationary. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. Note that this attribute is + superseded by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sankey.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + link + The links of the Sankey plot. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + node + The nodes of the Sankey plot. + orientation + Sets the orientation of the Sankey diagram. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + stream + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + valuesuffix + Adds a unit to follow the value in the hover tooltip. + Add a space if a separation is necessary from the + value. + 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). + """ + + def __init__( + self, + arg=None, + arrangement=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverlabel=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=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, + ): + """ + Construct a new Sankey object + + Sankey plots for network flow data analysis. The nodes are + specified in `nodes` and the links between sources and targets + in `links`. The colors are set in `nodes[i].color` and + `links[i].color`, otherwise defaults are used. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Sankey` + arrangement + If value is `snap` (the default), the node arrangement + is assisted by automatic snapping of elements to + preserve space between nodes specified via `nodepad`. + If value is `perpendicular`, the nodes can only move + along a line perpendicular to the flow. If value is + `freeform`, the nodes can freely move on the plane. If + value is `fixed`, the nodes are stationary. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sankey.Domain` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. Note that this attribute is + superseded by `node.hoverinfo` and `node.hoverinfo` for + nodes and links respectively. + hoverlabel + :class:`plotly.graph_objects.sankey.Hoverlabel` + instance or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sankey.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + link + The links of the Sankey plot. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + node + The nodes of the Sankey plot. + orientation + Sets the orientation of the Sankey diagram. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + stream + :class:`plotly.graph_objects.sankey.Stream` instance or + dict with compatible properties + textfont + Sets the font for node labels + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + valuesuffix + Adds a unit to follow the value in the hover tooltip. + Add a space if a separation is necessary from the + value. + 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). + + Returns + ------- + Sankey + """ + super().__init__("sankey") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Sankey +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Sankey`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("arrangement", arg, arrangement) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("domain", arg, domain) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("link", arg, link) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("node", arg, node) + self._set_property("orientation", arg, orientation) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("stream", arg, stream) + self._set_property("textfont", arg, textfont) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("valueformat", arg, valueformat) + self._set_property("valuesuffix", arg, valuesuffix) + self._set_property("visible", arg, visible) + + self._props["type"] = "sankey" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter.py new file mode 100644 index 0000000..9bef62b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter.py @@ -0,0 +1,2750 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatter(_BaseTraceType): + _parent_path_str = "" + _path_str = "scatter" + _valid_props = { + "alignmentgroup", + "cliponaxis", + "connectgaps", + "customdata", + "customdatasrc", + "dx", + "dy", + "error_x", + "error_y", + "fill", + "fillcolor", + "fillgradient", + "fillpattern", + "groupnorm", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "offsetgroup", + "opacity", + "orientation", + "selected", + "selectedpoints", + "showlegend", + "stackgaps", + "stackgroup", + "stream", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "x", + "x0", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "y", + "y0", + "yaxis", + "ycalendar", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.ErrorX` + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Returns + ------- + plotly.graph_objs.scatter.ErrorX + """ + return self["error_x"] + + @error_x.setter + def error_x(self, val): + self["error_x"] = val + + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.ErrorY` + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Returns + ------- + plotly.graph_objs.scatter.ErrorY + """ + return self["error_y"] + + @error_y.setter + def error_y(self, val): + self["error_y"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Defaults to "none" + unless this trace is stacked, then it gets "tonexty" + ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 + respectively. "tonextx" and "tonexty" fill between the + endpoints of this trace and the endpoints of the trace before + it, connecting those endpoints with straight lines (to make a + stacked area graph); if there is no trace before it, they + behave like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the space between two + traces if one completely encloses the other (eg consecutive + contour lines), and behaves like "toself" if there is no trace + before it. "tonext" should not be used if one trace does not + enclose the other. Traces in a `stackgroup` will only fill to + (or be filled to) other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if fill- + linked traces are not already consecutive, the later ones will + be pushed down in the drawing order. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. If fillgradient is specified, fillcolor is + ignored except for setting the background color of the hover + label, if any. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def fillgradient(self): + """ + Sets a fill gradient. If not specified, the fillcolor is used + instead. + + The 'fillgradient' property is an instance of Fillgradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Fillgradient` + - A dict of string/value properties that will be passed + to the Fillgradient constructor + + Returns + ------- + plotly.graph_objs.scatter.Fillgradient + """ + return self["fillgradient"] + + @fillgradient.setter + def fillgradient(self, val): + self["fillgradient"] = val + + @property + def fillpattern(self): + """ + Sets the pattern within the marker. + + The 'fillpattern' property is an instance of Fillpattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Fillpattern` + - A dict of string/value properties that will be passed + to the Fillpattern constructor + + Returns + ------- + plotly.graph_objs.scatter.Fillpattern + """ + return self["fillpattern"] + + @fillpattern.setter + def fillpattern(self, val): + self["fillpattern"] = val + + @property + def groupnorm(self): + """ + Only relevant when `stackgroup` is used, and only the first + `groupnorm` found in the `stackgroup` will be used - including + if `visible` is "legendonly" but not if it is `false`. Sets the + normalization for the sum of this `stackgroup`. With + "fraction", the value of each trace at each location is divided + by the sum of all trace values at that location. "percent" is + the same but multiplied by 100 to show percentages. If there + are multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + + The 'groupnorm' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', 'fraction', 'percent'] + + Returns + ------- + Any + """ + return self["groupnorm"] + + @groupnorm.setter + def groupnorm(self, val): + self["groupnorm"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scatter.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scatter.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatter.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatter.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Only relevant in the following cases: 1. when `scattermode` is + set to "group". 2. when `stackgroup` is used, and only the + first `orientation` found in the `stackgroup` will be used - + including if `visible` is "legendonly" but not if it is + `false`. Sets the stacking direction. With "v" ("h"), the y (x) + values of subsequent traces are added. Also affects the default + value of `fill`. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scatter.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stackgaps(self): + """ + Only relevant when `stackgroup` is used, and only the first + `stackgaps` found in the `stackgroup` will be used - including + if `visible` is "legendonly" but not if it is `false`. + Determines how we handle locations at which other traces in + this group have data but this one does not. With *infer zero* + we insert a zero at these locations. With "interpolate" we + linearly interpolate between existing values, and extrapolate a + constant beyond the existing values. + + The 'stackgaps' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['infer zero', 'interpolate'] + + Returns + ------- + Any + """ + return self["stackgaps"] + + @stackgaps.setter + def stackgaps(self, val): + self["stackgaps"] = val + + @property + def stackgroup(self): + """ + Set several scatter traces (on the same subplot) to the same + stackgroup in order to add their y values (or their x values if + `orientation` is "h"). If blank or omitted this trace will not + be stacked. Stacking also turns `fill` on by default, using + "tonexty" ("tonextx") if `orientation` is "h" ("v") and sets + the default `mode` to "lines" irrespective of point count. You + can only stack on a numeric (linear or log) axis. Traces in a + `stackgroup` will only fill to (or be filled to) other traces + in the same group. With multiple `stackgroup`s or some traces + stacked and some not, if fill-linked traces are not already + consecutive, the later ones will be pushed down in the drawing + order. + + The 'stackgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["stackgroup"] + + @stackgroup.setter + def stackgroup(self, val): + self["stackgroup"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scatter.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatter.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scatter.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. If fillgradient is + specified, fillcolor is ignored except for setting the + background color of the hover label, if any. + fillgradient + Sets a fill gradient. If not specified, the fillcolor + is used instead. + fillpattern + Sets the pattern within the marker. + groupnorm + Only relevant when `stackgroup` is used, and only the + first `groupnorm` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value of each + trace at each location is divided by the sum of all + trace values at that location. "percent" is the same + but multiplied by 100 to show percentages. If there are + multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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. + opacity + Sets the opacity of the trace. + orientation + Only relevant in the following cases: 1. when + `scattermode` is set to "group". 2. when `stackgroup` + is used, and only the first `orientation` found in the + `stackgroup` will be used - including if `visible` is + "legendonly" but not if it is `false`. Sets the + stacking direction. With "v" ("h"), the y (x) values of + subsequent traces are added. Also affects the default + value of `fill`. + selected + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and only the + first `stackgaps` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Determines how we handle locations at + which other traces in this group have data but this one + does not. With *infer zero* we insert a zero at these + locations. With "interpolate" we linearly interpolate + between existing values, and extrapolate a constant + beyond the existing values. + stackgroup + Set several scatter traces (on the same subplot) to the + same stackgroup in order to add their y values (or + their x values if `orientation` is "h"). If blank or + omitted this trace will not be stacked. Stacking also + turns `fill` on by default, using "tonexty" ("tonextx") + if `orientation` is "h" ("v") and sets the default + `mode` to "lines" irrespective of point count. You can + only stack on a numeric (linear or log) axis. Traces in + a `stackgroup` will only fill to (or be filled to) + other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if + fill-linked traces are not already consecutive, the + later ones will be pushed down in the drawing order. + stream + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + fillgradient=None, + fillpattern=None, + groupnorm=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + selected=None, + selectedpoints=None, + showlegend=None, + stackgaps=None, + stackgroup=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Scatter object + + The scatter trace type encompasses line charts, scatter charts, + text charts, and bubble charts. The data visualized as scatter + point or lines is set in `x` and `y`. Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scatter` + 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. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scatter.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. If fillgradient is + specified, fillcolor is ignored except for setting the + background color of the hover label, if any. + fillgradient + Sets a fill gradient. If not specified, the fillcolor + is used instead. + fillpattern + Sets the pattern within the marker. + groupnorm + Only relevant when `stackgroup` is used, and only the + first `groupnorm` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Sets the normalization for the sum of + this `stackgroup`. With "fraction", the value of each + trace at each location is divided by the sum of all + trace values at that location. "percent" is the same + but multiplied by 100 to show percentages. If there are + multiple subplots, or multiple `stackgroup`s on one + subplot, each will be normalized within its own set. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.scatter.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + 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. + opacity + Sets the opacity of the trace. + orientation + Only relevant in the following cases: 1. when + `scattermode` is set to "group". 2. when `stackgroup` + is used, and only the first `orientation` found in the + `stackgroup` will be used - including if `visible` is + "legendonly" but not if it is `false`. Sets the + stacking direction. With "v" ("h"), the y (x) values of + subsequent traces are added. Also affects the default + value of `fill`. + selected + :class:`plotly.graph_objects.scatter.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stackgaps + Only relevant when `stackgroup` is used, and only the + first `stackgaps` found in the `stackgroup` will be + used - including if `visible` is "legendonly" but not + if it is `false`. Determines how we handle locations at + which other traces in this group have data but this one + does not. With *infer zero* we insert a zero at these + locations. With "interpolate" we linearly interpolate + between existing values, and extrapolate a constant + beyond the existing values. + stackgroup + Set several scatter traces (on the same subplot) to the + same stackgroup in order to add their y values (or + their x values if `orientation` is "h"). If blank or + omitted this trace will not be stacked. Stacking also + turns `fill` on by default, using "tonexty" ("tonextx") + if `orientation` is "h" ("v") and sets the default + `mode` to "lines" irrespective of point count. You can + only stack on a numeric (linear or log) axis. Traces in + a `stackgroup` will only fill to (or be filled to) + other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if + fill-linked traces are not already consecutive, the + later ones will be pushed down in the drawing order. + stream + :class:`plotly.graph_objects.scatter.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatter.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Scatter + """ + super().__init__("scatter") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scatter +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scatter`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("error_x", arg, error_x) + self._set_property("error_y", arg, error_y) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("fillgradient", arg, fillgradient) + self._set_property("fillpattern", arg, fillpattern) + self._set_property("groupnorm", arg, groupnorm) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stackgaps", arg, stackgaps) + self._set_property("stackgroup", arg, stackgroup) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "scatter" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter3d.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter3d.py new file mode 100644 index 0000000..229056e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatter3d.py @@ -0,0 +1,1995 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatter3d(_BaseTraceType): + _parent_path_str = "" + _path_str = "scatter3d" + _valid_props = { + "connectgaps", + "customdata", + "customdatasrc", + "error_x", + "error_y", + "error_z", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "projection", + "scene", + "showlegend", + "stream", + "surfaceaxis", + "surfacecolor", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "visible", + "x", + "xcalendar", + "xhoverformat", + "xsrc", + "y", + "ycalendar", + "yhoverformat", + "ysrc", + "z", + "zcalendar", + "zhoverformat", + "zsrc", + } + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.ErrorX` + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Returns + ------- + plotly.graph_objs.scatter3d.ErrorX + """ + return self["error_x"] + + @error_x.setter + def error_x(self, val): + self["error_x"] = val + + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.ErrorY` + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Returns + ------- + plotly.graph_objs.scatter3d.ErrorY + """ + return self["error_y"] + + @error_y.setter + def error_y(self, val): + self["error_y"] = val + + @property + def error_z(self): + """ + The 'error_z' property is an instance of ErrorZ + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.ErrorZ` + - A dict of string/value properties that will be passed + to the ErrorZ constructor + + Returns + ------- + plotly.graph_objs.scatter3d.ErrorZ + """ + return self["error_z"] + + @error_z.setter + def error_z(self, val): + self["error_z"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets text elements associated with each (x,y,z) triplet. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y,z) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def projection(self): + """ + The 'projection' property is an instance of Projection + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Projection` + - A dict of string/value properties that will be passed + to the Projection constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Projection + """ + return self["projection"] + + @projection.setter + def projection(self, val): + self["projection"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def surfaceaxis(self): + """ + If "-1", the scatter points are not fill with a surface If 0, + 1, 2, the scatter points are filled with a Delaunay surface + about the x, y, z respectively. + + The 'surfaceaxis' property is an enumeration that may be specified as: + - One of the following enumeration values: + [-1, 0, 1, 2] + + Returns + ------- + Any + """ + return self["surfaceaxis"] + + @surfaceaxis.setter + def surfaceaxis(self, val): + self["surfaceaxis"] = val + + @property + def surfacecolor(self): + """ + Sets the surface fill color. + + The 'surfacecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["surfacecolor"] + + @surfacecolor.setter + def surfacecolor(self, val): + self["surfacecolor"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y,z) triplet. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y,z) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatter3d.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the z coordinates. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zcalendar(self): + """ + Sets the calendar system to use with `z` date data. + + The 'zcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["zcalendar"] + + @zcalendar.setter + def zcalendar(self, val): + self["zcalendar"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties + error_z + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter3d.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + projection + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a surface + If 0, 1, 2, the scatter points are filled with a + Delaunay surface about the x, y, z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + error_x=None, + error_y=None, + error_z=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + projection=None, + scene=None, + showlegend=None, + stream=None, + surfaceaxis=None, + surfacecolor=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Scatter3d object + + The data visualized as scatter point or lines in 3D dimension + is set in `x`, `y`, `z`. Text (appearing either on the chart or + on hover only) is via `text`. Bubble charts are achieved by + setting `marker.size` and/or `marker.color` Projections are + achieved via `projection`. Surface fills are achieved via + `surfaceaxis`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scatter3d` + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + error_x + :class:`plotly.graph_objects.scatter3d.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scatter3d.ErrorY` instance + or dict with compatible properties + error_z + :class:`plotly.graph_objects.scatter3d.ErrorZ` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatter3d.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatter3d.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatter3d.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scatter3d.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + projection + :class:`plotly.graph_objects.scatter3d.Projection` + instance or dict with compatible properties + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatter3d.Stream` instance + or dict with compatible properties + surfaceaxis + If "-1", the scatter points are not fill with a surface + If 0, 1, 2, the scatter points are filled with a + Delaunay surface about the x, y, z respectively. + surfacecolor + Sets the surface fill color. + text + Sets text elements associated with each (x,y,z) + triplet. If a single string, the same string appears + over all the data points. If an array of string, the + items are mapped in order to the this trace's (x,y,z) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Scatter3d + """ + super().__init__("scatter3d") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scatter3d +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scatter3d`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("error_x", arg, error_x) + self._set_property("error_y", arg, error_y) + self._set_property("error_z", arg, error_z) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("projection", arg, projection) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("surfaceaxis", arg, surfaceaxis) + self._set_property("surfacecolor", arg, surfacecolor) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zcalendar", arg, zcalendar) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "scatter3d" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattercarpet.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattercarpet.py new file mode 100644 index 0000000..4b846bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattercarpet.py @@ -0,0 +1,1826 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattercarpet(_BaseTraceType): + _parent_path_str = "" + _path_str = "scattercarpet" + _valid_props = { + "a", + "asrc", + "b", + "bsrc", + "carpet", + "connectgaps", + "customdata", + "customdatasrc", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "stream", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "xaxis", + "yaxis", + "zorder", + } + + @property + def a(self): + """ + Sets the a-axis coordinates. + + The 'a' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["a"] + + @a.setter + def a(self, val): + self["a"] = val + + @property + def asrc(self): + """ + Sets the source reference on Chart Studio Cloud for `a`. + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["asrc"] + + @asrc.setter + def asrc(self, val): + self["asrc"] = val + + @property + def b(self): + """ + Sets the b-axis coordinates. + + The 'b' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def bsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `b`. + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bsrc"] + + @bsrc.setter + def bsrc(self, val): + self["bsrc"] = val + + @property + def carpet(self): + """ + An identifier for this carpet, so that `scattercarpet` and + `contourcarpet` traces can specify a carpet plot on which they + lie + + The 'carpet' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["carpet"] + + @carpet.setter + def carpet(self, val): + self["carpet"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scatterternary has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['a', 'b', 'text', 'name'] joined with '+' characters + (e.g. 'a+b') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (a,b) point. If a + single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b). To be seen, trace `hoverinfo` + must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (a,b) point. If a + single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b). If trace `hoverinfo` contains + a "text" flag and "hovertext" is not set, these elements will + be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `a`, `b` + and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + a + Sets the a-axis coordinates. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b). To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattercarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (a,b) point. If + a single string, the same string appears over all the + data points. If an array of strings, the items are + mapped in order to the the data points in (a,b). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + a=None, + asrc=None, + b=None, + bsrc=None, + carpet=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxis=None, + yaxis=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Scattercarpet object + + Plots a scatter trace on either the first carpet axis or the + carpet axis with a matching `carpet` attribute. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scattercarpet` + a + Sets the a-axis coordinates. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the b-axis coordinates. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + carpet + An identifier for this carpet, so that `scattercarpet` + and `contourcarpet` traces can specify a carpet plot on + which they lie + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattercarpet.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b). To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattercarpet.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattercarpet.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattercarpet.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattercarpet.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattercarpet.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (a,b) point. If + a single string, the same string appears over all the + data points. If an array of strings, the items are + mapped in order to the the data points in (a,b). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattercarpet.Unselected` + instance or dict with compatible properties + 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). + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Scattercarpet + """ + super().__init__("scattercarpet") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scattercarpet +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scattercarpet`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("a", arg, a) + self._set_property("asrc", arg, asrc) + self._set_property("b", arg, b) + self._set_property("bsrc", arg, bsrc) + self._set_property("carpet", arg, carpet) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("xaxis", arg, xaxis) + self._set_property("yaxis", arg, yaxis) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "scattercarpet" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergeo.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergeo.py new file mode 100644 index 0000000..4c0fb09 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergeo.py @@ -0,0 +1,1854 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattergeo(_BaseTraceType): + _parent_path_str = "" + _path_str = "scattergeo" + _valid_props = { + "connectgaps", + "customdata", + "customdatasrc", + "featureidkey", + "fill", + "fillcolor", + "geo", + "geojson", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "lat", + "latsrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "locationmode", + "locations", + "locationssrc", + "lon", + "lonsrc", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "stream", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def featureidkey(self): + """ + Sets the key in GeoJSON features which is used as id to match + the items included in the `locations` array. Only has an effect + when `geojson` is set. Support nested property, for example + "properties.name". + + The 'featureidkey' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["featureidkey"] + + @featureidkey.setter + def featureidkey(self, val): + self["featureidkey"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". "toself" connects the endpoints of the trace (or + each segment of the trace if it has gaps) into a closed shape. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def geo(self): + """ + Sets a reference between this trace's geospatial coordinates + and a geographic map. If "geo" (the default value), the + geospatial coordinates refer to `layout.geo`. If "geo2", the + geospatial coordinates refer to `layout.geo2`, and so on. + + The 'geo' property is an identifier of a particular + subplot, of type 'geo', that may be specified as the string 'geo' + optionally followed by an integer >= 1 + (e.g. 'geo', 'geo1', 'geo2', 'geo3', etc.) + + Returns + ------- + str + """ + return self["geo"] + + @geo.setter + def geo(self, val): + self["geo"] = val + + @property + def geojson(self): + """ + Sets optional GeoJSON data associated with this trace. If not + given, the features on the base map are used when `locations` + is set. 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". + + The 'geojson' property accepts values of any type + + Returns + ------- + Any + """ + return self["geojson"] + + @geojson.setter + def geojson(self, val): + self["geojson"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lon', 'lat', 'location', 'text', 'name'] joined with '+' characters + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair or + item in `locations`. If a single string, the same string + appears over all the data points. If an array of string, the + items are mapped in order to the this trace's (lon,lat) or + `locations` coordinates. To be seen, trace `hoverinfo` must + contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def lat(self): + """ + Sets the latitude coordinates (in degrees North). + + The 'lat' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def latsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lat`. + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["latsrc"] + + @latsrc.setter + def latsrc(self, val): + self["latsrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def locationmode(self): + """ + Determines the set of locations used to match entries in + `locations` 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 `geojson` attribute. + + The 'locationmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['ISO-3', 'USA-states', 'country names', 'geojson-id'] + + Returns + ------- + Any + """ + return self["locationmode"] + + @locationmode.setter + def locationmode(self, val): + self["locationmode"] = val + + @property + def locations(self): + """ + Sets the coordinates via location IDs or names. Coordinates + correspond to the centroid of each location given. See + `locationmode` for more info. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def lon(self): + """ + Sets the longitude coordinates (in degrees East). + + The 'lon' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def lonsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lon`. + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lonsrc"] + + @lonsrc.setter + def lonsrc(self, val): + self["lonsrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair or item + in `locations`. If a single string, the same string appears + over all the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) or `locations` + coordinates. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `lat`, + `lon`, `location` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scattergeo.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + geojson + Sets optional GeoJSON data associated with this trace. + If not given, the features on the base map are used + when `locations` is set. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair or item in `locations`. If a single string, the + same string appears over all the data points. If an + array of string, the items are mapped in order to the + this trace's (lon,lat) or `locations` coordinates. To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergeo.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each location + given. See `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (lon,lat) pair + or item in `locations`. If a single string, the same + string appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and "hovertext" is + not set, these elements will be seen in the hover + labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon`, `location` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + featureidkey=None, + fill=None, + fillcolor=None, + geo=None, + geojson=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + locationmode=None, + locations=None, + locationssrc=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scattergeo object + + The data visualized as scatter point or lines on a geographic + map is provided either by longitude/latitude pairs in `lon` and + `lat` respectively or by geographic location IDs or names in + `locations`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scattergeo` + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + featureidkey + Sets the key in GeoJSON features which is used as id to + match the items included in the `locations` array. Only + has an effect when `geojson` is set. Support nested + property, for example "properties.name". + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + geo + Sets a reference between this trace's geospatial + coordinates and a geographic map. If "geo" (the default + value), the geospatial coordinates refer to + `layout.geo`. If "geo2", the geospatial coordinates + refer to `layout.geo2`, and so on. + geojson + Sets optional GeoJSON data associated with this trace. + If not given, the features on the base map are used + when `locations` is set. 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". + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergeo.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair or item in `locations`. If a single string, the + same string appears over all the data points. If an + array of string, the items are mapped in order to the + this trace's (lon,lat) or `locations` coordinates. To + be seen, trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergeo.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergeo.Line` instance + or dict with compatible properties + locationmode + Determines the set of locations used to match entries + in `locations` 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 `geojson` + attribute. + locations + Sets the coordinates via location IDs or names. + Coordinates correspond to the centroid of each location + given. See `locationmode` for more info. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattergeo.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergeo.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergeo.Stream` + instance or dict with compatible properties + text + Sets text elements associated with each (lon,lat) pair + or item in `locations`. If a single string, the same + string appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (lon,lat) or `locations` coordinates. If trace + `hoverinfo` contains a "text" flag and "hovertext" is + not set, these elements will be seen in the hover + labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon`, `location` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergeo.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scattergeo + """ + super().__init__("scattergeo") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scattergeo +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scattergeo`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("featureidkey", arg, featureidkey) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("geo", arg, geo) + self._set_property("geojson", arg, geojson) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("lat", arg, lat) + self._set_property("latsrc", arg, latsrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("locationmode", arg, locationmode) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("lon", arg, lon) + self._set_property("lonsrc", arg, lonsrc) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scattergeo" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergl.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergl.py new file mode 100644 index 0000000..bccddc4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattergl.py @@ -0,0 +1,2287 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattergl(_BaseTraceType): + _parent_path_str = "" + _path_str = "scattergl" + _valid_props = { + "connectgaps", + "customdata", + "customdatasrc", + "dx", + "dy", + "error_x", + "error_y", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "stream", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "x", + "x0", + "xaxis", + "xcalendar", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "y", + "y0", + "yaxis", + "ycalendar", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + } + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def error_x(self): + """ + The 'error_x' property is an instance of ErrorX + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.ErrorX` + - A dict of string/value properties that will be passed + to the ErrorX constructor + + Returns + ------- + plotly.graph_objs.scattergl.ErrorX + """ + return self["error_x"] + + @error_x.setter + def error_x(self, val): + self["error_x"] = val + + @property + def error_y(self): + """ + The 'error_y' property is an instance of ErrorY + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.ErrorY` + - A dict of string/value properties that will be passed + to the ErrorY constructor + + Returns + ------- + plotly.graph_objs.scattergl.ErrorY + """ + return self["error_y"] + + @error_y.setter + def error_y(self, val): + self["error_y"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Defaults to "none" + unless this trace is stacked, then it gets "tonexty" + ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 + respectively. "tonextx" and "tonexty" fill between the + endpoints of this trace and the endpoints of the trace before + it, connecting those endpoints with straight lines (to make a + stacked area graph); if there is no trace before it, they + behave like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the space between two + traces if one completely encloses the other (eg consecutive + contour lines), and behaves like "toself" if there is no trace + before it. "tonext" should not be used if one trace does not + enclose the other. Traces in a `stackgroup` will only fill to + (or be filled to) other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if fill- + linked traces are not already consecutive, the later ones will + be pushed down in the drawing order. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scattergl.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scattergl.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattergl.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattergl.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scattergl.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scattergl.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattergl.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scattergl.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergl.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dx=None, + dy=None, + error_x=None, + error_y=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + x=None, + x0=None, + xaxis=None, + xcalendar=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + ycalendar=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + **kwargs, + ): + """ + Construct a new Scattergl object + + The data visualized as scatter point or lines is set in `x` and + `y` using the WebGL plotting engine. Bubble charts are achieved + by setting `marker.size` and/or `marker.color` to a numerical + arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scattergl` + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + error_x + :class:`plotly.graph_objects.scattergl.ErrorX` instance + or dict with compatible properties + error_y + :class:`plotly.graph_objects.scattergl.ErrorY` instance + or dict with compatible properties + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattergl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattergl.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattergl.Line` instance + or dict with compatible properties + marker + :class:`plotly.graph_objects.scattergl.Marker` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattergl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattergl.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattergl.Unselected` + instance or dict with compatible properties + 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). + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + + Returns + ------- + Scattergl + """ + super().__init__("scattergl") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scattergl +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scattergl`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("error_x", arg, error_x) + self._set_property("error_y", arg, error_y) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + + self._props["type"] = "scattergl" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermap.py new file mode 100644 index 0000000..a4b82a9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermap.py @@ -0,0 +1,1708 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattermap(_BaseTraceType): + _parent_path_str = "" + _path_str = "scattermap" + _valid_props = { + "below", + "cluster", + "connectgaps", + "customdata", + "customdatasrc", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "lat", + "latsrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "lon", + "lonsrc", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "text", + "textfont", + "textposition", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def below(self): + """ + Determines if this scattermap trace's layers are to be inserted + before the layer with the specified ID. By default, scattermap + layers are inserted above all the base layers. To place the + scattermap layers above every other layer, set `below` to "''". + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def cluster(self): + """ + The 'cluster' property is an instance of Cluster + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Cluster` + - A dict of string/value properties that will be passed + to the Cluster constructor + + Returns + ------- + plotly.graph_objs.scattermap.Cluster + """ + return self["cluster"] + + @cluster.setter + def cluster(self, val): + self["cluster"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". "toself" connects the endpoints of the trace (or + each segment of the trace if it has gaps) into a closed shape. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scattermap.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def lat(self): + """ + Sets the latitude coordinates (in degrees North). + + The 'lat' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def latsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lat`. + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["latsrc"] + + @latsrc.setter + def latsrc(self, val): + self["latsrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scattermap.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattermap.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def lon(self): + """ + Sets the longitude coordinates (in degrees East). + + The 'lon' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def lonsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lon`. + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lonsrc"] + + @lonsrc.setter + def lonsrc(self, val): + self["lonsrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattermap.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scattermap.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scattermap.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + map subplot. If "map" (the default value), the data refer to + `layout.map`. If "map2", the data refer to `layout.map2`, and + so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'map', that may be specified as the string 'map' + optionally followed by an integer >= 1 + (e.g. 'map', 'map1', 'map2', 'map3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the icon text font (color=map.layer.paint.text-color, + size=map.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattermap.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `lat`, + `lon` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scattermap.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + below + Determines if this scattermap trace's layers are to be + inserted before the layer with the specified ID. By + default, scattermap layers are inserted above all the + base layers. To place the scattermap layers above every + other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermap.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermap.Line` instance + or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=map.layer.paint.text- + color, size=map.layer.layout.text-size). Has an effect + only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermap.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + below=None, + cluster=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scattermap object + + The data visualized as scatter point, lines or marker symbols + on a MapLibre GL geographic map is provided by + longitude/latitude pairs in `lon` and `lat`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scattermap` + below + Determines if this scattermap trace's layers are to be + inserted before the layer with the specified ID. By + default, scattermap layers are inserted above all the + base layers. To place the scattermap layers above every + other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermap.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermap.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermap.Line` instance + or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermap.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermap.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermap.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a map subplot. If "map" (the default value), the + data refer to `layout.map`. If "map2", the data refer + to `layout.map2`, and so on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=map.layer.paint.text- + color, size=map.layer.layout.text-size). Has an effect + only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermap.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scattermap + """ + super().__init__("scattermap") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scattermap +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scattermap`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("below", arg, below) + self._set_property("cluster", arg, cluster) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("lat", arg, lat) + self._set_property("latsrc", arg, latsrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("lon", arg, lon) + self._set_property("lonsrc", arg, lonsrc) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scattermap" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermapbox.py new file mode 100644 index 0000000..3c20238 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattermapbox.py @@ -0,0 +1,1736 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy +import warnings + + +class Scattermapbox(_BaseTraceType): + _parent_path_str = "" + _path_str = "scattermapbox" + _valid_props = { + "below", + "cluster", + "connectgaps", + "customdata", + "customdatasrc", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "lat", + "latsrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "lon", + "lonsrc", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "text", + "textfont", + "textposition", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def below(self): + """ + Determines if this scattermapbox trace's layers are to be + inserted before the layer with the specified ID. By default, + scattermapbox layers are inserted above all the base layers. To + place the scattermapbox layers above every other layer, set + `below` to "''". + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def cluster(self): + """ + The 'cluster' property is an instance of Cluster + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Cluster` + - A dict of string/value properties that will be passed + to the Cluster constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Cluster + """ + return self["cluster"] + + @cluster.setter + def cluster(self, val): + self["cluster"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". "toself" connects the endpoints of the trace (or + each segment of the trace if it has gaps) into a closed shape. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lon', 'lat', 'text', 'name'] joined with '+' characters + (e.g. 'lon+lat') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (lon,lat) pair If + a single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def lat(self): + """ + Sets the latitude coordinates (in degrees North). + + The 'lat' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def latsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lat`. + + The 'latsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["latsrc"] + + @latsrc.setter + def latsrc(self, val): + self["latsrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def lon(self): + """ + Sets the longitude coordinates (in degrees East). + + The 'lon' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def lonsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `lon`. + + The 'lonsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["lonsrc"] + + @lonsrc.setter + def lonsrc(self, val): + self["lonsrc"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + mapbox subplots and traces are deprecated! Please consider + switching to `map` subplots and traces. Learn more at: + https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ Sets a + reference between this trace's data coordinates and a mapbox + subplot. If "mapbox" (the default value), the data refer to + `layout.mapbox`. If "mapbox2", the data refer to + `layout.mapbox2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'mapbox', that may be specified as the string 'mapbox' + optionally followed by an integer >= 1 + (e.g. 'mapbox', 'mapbox1', 'mapbox2', 'mapbox3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (lon,lat) pair If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (lon,lat) coordinates. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the icon text font (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `lat`, + `lon` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + below + Determines if this scattermapbox trace's layers are to + be inserted before the layer with the specified ID. By + default, scattermapbox layers are inserted above all + the base layers. To place the scattermapbox layers + above every other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermapbox.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + below=None, + cluster=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + lat=None, + latsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + lon=None, + lonsrc=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scattermapbox object + + "scattermapbox" trace is deprecated! Please consider switching + to the "scattermap" trace type and `map` subplots. Learn more + at: https://plotly.com/python/maplibre-migration/ as well as + https://plotly.com/javascript/maplibre-migration/ The data + visualized as scatter point, lines or marker symbols on a + Mapbox GL geographic map is provided by longitude/latitude + pairs in `lon` and `lat`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scattermapbox` + below + Determines if this scattermapbox trace's layers are to + be inserted before the layer with the specified ID. By + default, scattermapbox layers are inserted above all + the base layers. To place the scattermapbox layers + above every other layer, set `below` to "''". + cluster + :class:`plotly.graph_objects.scattermapbox.Cluster` + instance or dict with compatible properties + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattermapbox.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (lon,lat) + pair If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (lon,lat) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + lat + Sets the latitude coordinates (in degrees North). + latsrc + Sets the source reference on Chart Studio Cloud for + `lat`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattermapbox.Legendgroupt + itle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattermapbox.Line` + instance or dict with compatible properties + lon + Sets the longitude coordinates (in degrees East). + lonsrc + Sets the source reference on Chart Studio Cloud for + `lon`. + marker + :class:`plotly.graph_objects.scattermapbox.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scattermapbox.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattermapbox.Stream` + instance or dict with compatible properties + subplot + mapbox subplots and traces are deprecated! Please + consider switching to `map` subplots and traces. Learn + more at: https://plotly.com/python/maplibre-migration/ + as well as https://plotly.com/javascript/maplibre- + migration/ Sets a reference between this trace's data + coordinates and a mapbox subplot. If "mapbox" (the + default value), the data refer to `layout.mapbox`. If + "mapbox2", the data refer to `layout.mapbox2`, and so + on. + text + Sets text elements associated with each (lon,lat) pair + If a single string, the same string appears over all + the data points. If an array of string, the items are + mapped in order to the this trace's (lon,lat) + coordinates. If trace `hoverinfo` contains a "text" + flag and "hovertext" is not set, these elements will be + seen in the hover labels. + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `lat`, `lon` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattermapbox.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scattermapbox + """ + super().__init__("scattermapbox") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scattermapbox +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scattermapbox`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("below", arg, below) + self._set_property("cluster", arg, cluster) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("lat", arg, lat) + self._set_property("latsrc", arg, latsrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("lon", arg, lon) + self._set_property("lonsrc", arg, lonsrc) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scattermapbox" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False + + warnings.warn( + "*scattermapbox* is deprecated!" + + " Use *scattermap* instead." + + " Learn more at: https://plotly.com/python/mapbox-to-maplibre/", + stacklevel=2, + category=DeprecationWarning, + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolar.py new file mode 100644 index 0000000..5168023 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolar.py @@ -0,0 +1,1913 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatterpolar(_BaseTraceType): + _parent_path_str = "" + _path_str = "scatterpolar" + _valid_props = { + "cliponaxis", + "connectgaps", + "customdata", + "customdatasrc", + "dr", + "dtheta", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "r", + "r0", + "rsrc", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "theta", + "theta0", + "thetasrc", + "thetaunit", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dr(self): + """ + Sets the r coordinate step. + + The 'dr' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dr"] + + @dr.setter + def dr(self, val): + self["dr"] = val + + @property + def dtheta(self): + """ + Sets the theta coordinate step. By default, the `dtheta` step + equals the subplot's period divided by the length of the `r` + coordinates. + + The 'dtheta' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dtheta"] + + @dtheta.setter + def dtheta(self, val): + self["dtheta"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scatterpolar has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters + (e.g. 'r+theta') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def r(self): + """ + Sets the radial coordinates + + The 'r' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def r0(self): + """ + Alternate to `r`. Builds a linear space of r coordinates. Use + with `dr` where `r0` is the starting coordinate and `dr` the + step. + + The 'r0' property accepts values of any type + + Returns + ------- + Any + """ + return self["r0"] + + @r0.setter + def r0(self, val): + self["r0"] = val + + @property + def rsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `r`. + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["rsrc"] + + @rsrc.setter + def rsrc(self, val): + self["rsrc"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + polar subplot. If "polar" (the default value), the data refer + to `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'polar', that may be specified as the string 'polar' + optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `r`, + `theta` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def theta(self): + """ + Sets the angular coordinates + + The 'theta' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["theta"] + + @theta.setter + def theta(self, val): + self["theta"] = val + + @property + def theta0(self): + """ + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the starting + coordinate and `dtheta` the step. + + The 'theta0' property accepts values of any type + + Returns + ------- + Any + """ + return self["theta0"] + + @theta0.setter + def theta0(self, val): + self["theta0"] = val + + @property + def thetasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `theta`. + + The 'thetasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["thetasrc"] + + @thetasrc.setter + def thetasrc(self, val): + self["thetasrc"] = val + + @property + def thetaunit(self): + """ + Sets the unit of input "theta" values. Has an effect only when + on "linear" angular axes. + + The 'thetaunit' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radians', 'degrees', 'gradians'] + + Returns + ------- + Any + """ + return self["thetaunit"] + + @thetaunit.setter + def thetaunit(self, val): + self["thetaunit"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterpolar has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolar.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scatterpolar object + + The scatterpolar trace type encompasses line charts, scatter + charts, text charts, and bubble charts in polar coordinates. + The data visualized as scatter point or lines is set in `r` + (radial) and `theta` (angular) coordinates Text (appearing + either on the chart or on hover only) is via `text`. Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scatterpolar` + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterpolar has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolar.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolar.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolar.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolar.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolar.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolar.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolar.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scatterpolar + """ + super().__init__("scatterpolar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scatterpolar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scatterpolar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dr", arg, dr) + self._set_property("dtheta", arg, dtheta) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("r", arg, r) + self._set_property("r0", arg, r0) + self._set_property("rsrc", arg, rsrc) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("theta", arg, theta) + self._set_property("theta0", arg, theta0) + self._set_property("thetasrc", arg, thetasrc) + self._set_property("thetaunit", arg, thetaunit) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scatterpolar" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolargl.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolargl.py new file mode 100644 index 0000000..f75aa05 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterpolargl.py @@ -0,0 +1,1874 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatterpolargl(_BaseTraceType): + _parent_path_str = "" + _path_str = "scatterpolargl" + _valid_props = { + "connectgaps", + "customdata", + "customdatasrc", + "dr", + "dtheta", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "r", + "r0", + "rsrc", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "theta", + "theta0", + "thetasrc", + "thetaunit", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def dr(self): + """ + Sets the r coordinate step. + + The 'dr' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dr"] + + @dr.setter + def dr(self, val): + self["dr"] = val + + @property + def dtheta(self): + """ + Sets the theta coordinate step. By default, the `dtheta` step + equals the subplot's period divided by the length of the `r` + coordinates. + + The 'dtheta' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dtheta"] + + @dtheta.setter + def dtheta(self, val): + self["dtheta"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Defaults to "none" + unless this trace is stacked, then it gets "tonexty" + ("tonextx") if `orientation` is "v" ("h") Use with `fillcolor` + if not "none". "tozerox" and "tozeroy" fill to x=0 and y=0 + respectively. "tonextx" and "tonexty" fill between the + endpoints of this trace and the endpoints of the trace before + it, connecting those endpoints with straight lines (to make a + stacked area graph); if there is no trace before it, they + behave like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if it has + gaps) into a closed shape. "tonext" fills the space between two + traces if one completely encloses the other (eg consecutive + contour lines), and behaves like "toself" if there is no trace + before it. "tonext" should not be used if one trace does not + enclose the other. Traces in a `stackgroup` will only fill to + (or be filled to) other traces in the same group. With multiple + `stackgroup`s or some traces stacked and some not, if fill- + linked traces are not already consecutive, the later ones will + be pushed down in the drawing order. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'tozeroy', 'tozerox', 'tonexty', 'tonextx', + 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['r', 'theta', 'text', 'name'] joined with '+' characters + (e.g. 'r+theta') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def r(self): + """ + Sets the radial coordinates + + The 'r' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def r0(self): + """ + Alternate to `r`. Builds a linear space of r coordinates. Use + with `dr` where `r0` is the starting coordinate and `dr` the + step. + + The 'r0' property accepts values of any type + + Returns + ------- + Any + """ + return self["r0"] + + @r0.setter + def r0(self, val): + self["r0"] = val + + @property + def rsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `r`. + + The 'rsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["rsrc"] + + @rsrc.setter + def rsrc(self, val): + self["rsrc"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + polar subplot. If "polar" (the default value), the data refer + to `layout.polar`. If "polar2", the data refer to + `layout.polar2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'polar', that may be specified as the string 'polar' + optionally followed by an integer >= 1 + (e.g. 'polar', 'polar1', 'polar2', 'polar3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `r`, + `theta` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def theta(self): + """ + Sets the angular coordinates + + The 'theta' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["theta"] + + @theta.setter + def theta(self, val): + self["theta"] = val + + @property + def theta0(self): + """ + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the starting + coordinate and `dtheta` the step. + + The 'theta0' property accepts values of any type + + Returns + ------- + Any + """ + return self["theta0"] + + @theta0.setter + def theta0(self, val): + self["theta0"] = val + + @property + def thetasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `theta`. + + The 'thetasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["thetasrc"] + + @thetasrc.setter + def thetasrc(self, val): + self["thetasrc"] = val + + @property + def thetaunit(self): + """ + Sets the unit of input "theta" values. Has an effect only when + on "linear" angular axes. + + The 'thetaunit' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radians', 'degrees', 'gradians'] + + Returns + ------- + Any + """ + return self["thetaunit"] + + @thetaunit.setter + def thetaunit(self, val): + self["thetaunit"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolargl.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + dr=None, + dtheta=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + r=None, + r0=None, + rsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + theta=None, + theta0=None, + thetasrc=None, + thetaunit=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scatterpolargl object + + The scatterpolargl trace type encompasses line charts, scatter + charts, and bubble charts in polar coordinates using the WebGL + plotting engine. The data visualized as scatter point or lines + is set in `r` (radial) and `theta` (angular) coordinates Bubble + charts are achieved by setting `marker.size` and/or + `marker.color` to numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.Scatterpolargl` + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + dr + Sets the r coordinate step. + dtheta + Sets the theta coordinate step. By default, the + `dtheta` step equals the subplot's period divided by + the length of the `r` coordinates. + fill + Sets the area to fill with a solid color. Defaults to + "none" unless this trace is stacked, then it gets + "tonexty" ("tonextx") if `orientation` is "v" ("h") Use + with `fillcolor` if not "none". "tozerox" and "tozeroy" + fill to x=0 and y=0 respectively. "tonextx" and + "tonexty" fill between the endpoints of this trace and + the endpoints of the trace before it, connecting those + endpoints with straight lines (to make a stacked area + graph); if there is no trace before it, they behave + like "tozerox" and "tozeroy". "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. Traces in a `stackgroup` will only fill to (or + be filled to) other traces in the same group. With + multiple `stackgroup`s or some traces stacked and some + not, if fill-linked traces are not already consecutive, + the later ones will be pushed down in the drawing + order. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterpolargl.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterpolargl.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterpolargl.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterpolargl.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + r + Sets the radial coordinates + r0 + Alternate to `r`. Builds a linear space of r + coordinates. Use with `dr` where `r0` is the starting + coordinate and `dr` the step. + rsrc + Sets the source reference on Chart Studio Cloud for + `r`. + selected + :class:`plotly.graph_objects.scatterpolargl.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterpolargl.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a polar subplot. If "polar" (the default value), + the data refer to `layout.polar`. If "polar2", the data + refer to `layout.polar2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `r`, `theta` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + theta + Sets the angular coordinates + theta0 + Alternate to `theta`. Builds a linear space of theta + coordinates. Use with `dtheta` where `theta0` is the + starting coordinate and `dtheta` the step. + thetasrc + Sets the source reference on Chart Studio Cloud for + `theta`. + thetaunit + Sets the unit of input "theta" values. Has an effect + only when on "linear" angular axes. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterpolargl.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scatterpolargl + """ + super().__init__("scatterpolargl") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scatterpolargl +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scatterpolargl`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("dr", arg, dr) + self._set_property("dtheta", arg, dtheta) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("r", arg, r) + self._set_property("r0", arg, r0) + self._set_property("rsrc", arg, rsrc) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("theta", arg, theta) + self._set_property("theta0", arg, theta0) + self._set_property("thetasrc", arg, thetasrc) + self._set_property("thetaunit", arg, thetaunit) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scatterpolargl" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattersmith.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattersmith.py new file mode 100644 index 0000000..e43d34b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scattersmith.py @@ -0,0 +1,1779 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scattersmith(_BaseTraceType): + _parent_path_str = "" + _path_str = "scattersmith" + _valid_props = { + "cliponaxis", + "connectgaps", + "customdata", + "customdatasrc", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "imag", + "imagsrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "real", + "realsrc", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scattersmith has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['real', 'imag', 'text', 'name'] joined with '+' characters + (e.g. 'real+imag') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def imag(self): + """ + Sets the imaginary component of the data, in units of + normalized impedance such that real=1, imag=0 is the center of + the chart. + + The 'imag' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["imag"] + + @imag.setter + def imag(self, val): + self["imag"] = val + + @property + def imagsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `imag`. + + The 'imagsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["imagsrc"] + + @imagsrc.setter + def imagsrc(self, val): + self["imagsrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def real(self): + """ + Sets the real component of the data, in units of normalized + impedance such that real=1, imag=0 is the center of the chart. + + The 'real' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["real"] + + @real.setter + def real(self, val): + self["real"] = val + + @property + def realsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `real`. + + The 'realsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["realsrc"] + + @realsrc.setter + def realsrc(self, val): + self["realsrc"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + smith subplot. If "smith" (the default value), the data refer + to `layout.smith`. If "smith2", the data refer to + `layout.smith2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'smith', that may be specified as the string 'smith' + optionally followed by an integer >= 1 + (e.g. 'smith', 'smith1', 'smith2', 'smith3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `real`, + `imag` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scattersmith.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scattersmith has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattersmith.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + imag + Sets the imaginary component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + imagsrc + Sets the source reference on Chart Studio Cloud for + `imag`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattersmith.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattersmith.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattersmith.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + real + Sets the real component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + realsrc + Sets the source reference on Chart Studio Cloud for + `real`. + selected + :class:`plotly.graph_objects.scattersmith.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattersmith.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a smith subplot. If "smith" (the default value), + the data refer to `layout.smith`. If "smith2", the data + refer to `layout.smith2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `real`, `imag` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattersmith.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + cliponaxis=None, + connectgaps=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + imag=None, + imagsrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + real=None, + realsrc=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scattersmith object + + The scattersmith trace type encompasses line charts, scatter + charts, text charts, and bubble charts in smith coordinates. + The data visualized as scatter point or lines is set in `real` + and `imag` (imaginary) coordinates Text (appearing either on + the chart or on hover only) is via `text`. Bubble charts are + achieved by setting `marker.size` and/or `marker.color` to + numerical arrays. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Scattersmith` + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scattersmith has a subset of + the options available to scatter. "toself" connects the + endpoints of the trace (or each segment of the trace if + it has gaps) into a closed shape. "tonext" fills the + space between two traces if one completely encloses the + other (eg consecutive contour lines), and behaves like + "toself" if there is no trace before it. "tonext" + should not be used if one trace does not enclose the + other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scattersmith.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + imag + Sets the imaginary component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + imagsrc + Sets the source reference on Chart Studio Cloud for + `imag`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scattersmith.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scattersmith.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scattersmith.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + real + Sets the real component of the data, in units of + normalized impedance such that real=1, imag=0 is the + center of the chart. + realsrc + Sets the source reference on Chart Studio Cloud for + `real`. + selected + :class:`plotly.graph_objects.scattersmith.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scattersmith.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a smith subplot. If "smith" (the default value), + the data refer to `layout.smith`. If "smith2", the data + refer to `layout.smith2`, and so on. + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `real`, `imag` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scattersmith.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scattersmith + """ + super().__init__("scattersmith") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scattersmith +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scattersmith`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("imag", arg, imag) + self._set_property("imagsrc", arg, imagsrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("real", arg, real) + self._set_property("realsrc", arg, realsrc) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scattersmith" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterternary.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterternary.py new file mode 100644 index 0000000..db865ea --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_scatterternary.py @@ -0,0 +1,1889 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Scatterternary(_BaseTraceType): + _parent_path_str = "" + _path_str = "scatterternary" + _valid_props = { + "a", + "asrc", + "b", + "bsrc", + "c", + "cliponaxis", + "connectgaps", + "csrc", + "customdata", + "customdatasrc", + "fill", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meta", + "metasrc", + "mode", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "stream", + "subplot", + "sum", + "text", + "textfont", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + } + + @property + def a(self): + """ + Sets the quantity of component `a` in each data point. If `a`, + `b`, and `c` are all provided, they need not be normalized, + only the relative values matter. If only two arrays are + provided they must be normalized to match `ternary.sum`. + + The 'a' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["a"] + + @a.setter + def a(self, val): + self["a"] = val + + @property + def asrc(self): + """ + Sets the source reference on Chart Studio Cloud for `a`. + + The 'asrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["asrc"] + + @asrc.setter + def asrc(self, val): + self["asrc"] = val + + @property + def b(self): + """ + Sets the quantity of component `a` in each data point. If `a`, + `b`, and `c` are all provided, they need not be normalized, + only the relative values matter. If only two arrays are + provided they must be normalized to match `ternary.sum`. + + The 'b' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def bsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `b`. + + The 'bsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bsrc"] + + @bsrc.setter + def bsrc(self, val): + self["bsrc"] = val + + @property + def c(self): + """ + Sets the quantity of component `a` in each data point. If `a`, + `b`, and `c` are all provided, they need not be normalized, + only the relative values matter. If only two arrays are + provided they must be normalized to match `ternary.sum`. + + The 'c' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["c"] + + @c.setter + def c(self, val): + self["c"] = val + + @property + def cliponaxis(self): + """ + Determines whether or not markers and text nodes are clipped + about the subplot axes. To show markers and text nodes above + axis lines and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the provided data arrays are connected. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def csrc(self): + """ + Sets the source reference on Chart Studio Cloud for `c`. + + The 'csrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["csrc"] + + @csrc.setter + def csrc(self, val): + self["csrc"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def fill(self): + """ + Sets the area to fill with a solid color. Use with `fillcolor` + if not "none". scatterternary has a subset of the options + available to scatter. "toself" connects the endpoints of the + trace (or each segment of the trace if it has gaps) into a + closed shape. "tonext" fills the space between two traces if + one completely encloses the other (eg consecutive contour + lines), and behaves like "toself" if there is no trace before + it. "tonext" should not be used if one trace does not enclose + the other. + + The 'fill' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'toself', 'tonext'] + + Returns + ------- + Any + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['a', 'b', 'c', 'text', 'name'] joined with '+' characters + (e.g. 'a+b') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual points (markers or + line points) or do they highlight filled regions? If the fill + is "toself" or "tonext" and there are no markers or text, then + the default is "fills", otherwise it is "points". + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['points', 'fills'] joined with '+' characters + (e.g. 'points+fills') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (a,b,c) point. If + a single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b,c). To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def mode(self): + """ + Determines the drawing mode for this scatter trace. If the + provided `mode` includes "text" then the `text` elements appear + at the coordinates. Otherwise, the `text` elements appear on + hover. If there are less than 20 points and the trace is not + stacked then the default is "lines+markers". Otherwise, + "lines". + + The 'mode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['lines', 'markers', 'text'] joined with '+' characters + (e.g. 'lines+markers') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def subplot(self): + """ + Sets a reference between this trace's data coordinates and a + ternary subplot. If "ternary" (the default value), the data + refer to `layout.ternary`. If "ternary2", the data refer to + `layout.ternary2`, and so on. + + The 'subplot' property is an identifier of a particular + subplot, of type 'ternary', that may be specified as the string 'ternary' + optionally followed by an integer >= 1 + (e.g. 'ternary', 'ternary1', 'ternary2', 'ternary3', etc.) + + Returns + ------- + str + """ + return self["subplot"] + + @subplot.setter + def subplot(self, val): + self["subplot"] = val + + @property + def sum(self): + """ + The number each triplet should sum to, if only two of `a`, `b`, + and `c` are provided. This overrides `ternary.sum` to + normalize this specific trace, but does not affect the values + displayed on the axes. 0 (or missing) means to use + ternary.sum + + The 'sum' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sum"] + + @sum.setter + def sum(self, val): + self["sum"] = val + + @property + def text(self): + """ + Sets text elements associated with each (a,b,c) point. If a + single string, the same string appears over all the data + points. If an array of strings, the items are mapped in order + to the the data points in (a,b,c). If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, these + elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the text font. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `a`, `b`, + `c` and `text`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.scatterternary.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + a + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + c + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + csrc + Sets the source reference on Chart Studio Cloud for + `c`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b,c) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b,c). + To be seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterternary.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a ternary subplot. If "ternary" (the default + value), the data refer to `layout.ternary`. If + "ternary2", the data refer to `layout.ternary2`, and so + on. + sum + The number each triplet should sum to, if only two of + `a`, `b`, and `c` are provided. This overrides + `ternary.sum` to normalize this specific trace, but + does not affect the values displayed on the axes. 0 (or + missing) means to use ternary.sum + text + Sets text elements associated with each (a,b,c) point. + If a single string, the same string appears over all + the data points. If an array of strings, the items are + mapped in order to the the data points in (a,b,c). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b`, `c` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties + 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). + """ + + def __init__( + self, + arg=None, + a=None, + asrc=None, + b=None, + bsrc=None, + c=None, + cliponaxis=None, + connectgaps=None, + csrc=None, + customdata=None, + customdatasrc=None, + fill=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meta=None, + metasrc=None, + mode=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + stream=None, + subplot=None, + sum=None, + text=None, + textfont=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + **kwargs, + ): + """ + Construct a new Scatterternary object + + Provides similar functionality to the "scatter" type but on a + ternary phase diagram. The data is provided by at least two + arrays out of `a`, `b`, `c` triplets. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.Scatterternary` + a + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + asrc + Sets the source reference on Chart Studio Cloud for + `a`. + b + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + bsrc + Sets the source reference on Chart Studio Cloud for + `b`. + c + Sets the quantity of component `a` in each data point. + If `a`, `b`, and `c` are all provided, they need not be + normalized, only the relative values matter. If only + two arrays are provided they must be normalized to + match `ternary.sum`. + cliponaxis + Determines whether or not markers and text nodes are + clipped about the subplot axes. To show markers and + text nodes above axis lines and tick labels, make sure + to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the provided data arrays are connected. + csrc + Sets the source reference on Chart Studio Cloud for + `c`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fill + Sets the area to fill with a solid color. Use with + `fillcolor` if not "none". scatterternary has a subset + of the options available to scatter. "toself" connects + the endpoints of the trace (or each segment of the + trace if it has gaps) into a closed shape. "tonext" + fills the space between two traces if one completely + encloses the other (eg consecutive contour lines), and + behaves like "toself" if there is no trace before it. + "tonext" should not be used if one trace does not + enclose the other. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.scatterternary.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual points + (markers or line points) or do they highlight filled + regions? If the fill is "toself" or "tonext" and there + are no markers or text, then the default is "fills", + otherwise it is "points". + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (a,b,c) + point. If a single string, the same string appears over + all the data points. If an array of strings, the items + are mapped in order to the the data points in (a,b,c). + To be seen, trace `hoverinfo` must contain a "text" + flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.scatterternary.Legendgroup + title` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.scatterternary.Line` + instance or dict with compatible properties + marker + :class:`plotly.graph_objects.scatterternary.Marker` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + mode + Determines the drawing mode for this scatter trace. If + the provided `mode` includes "text" then the `text` + elements appear at the coordinates. Otherwise, the + `text` elements appear on hover. If there are less than + 20 points and the trace is not stacked then the default + is "lines+markers". Otherwise, "lines". + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.scatterternary.Selected` + instance or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.scatterternary.Stream` + instance or dict with compatible properties + subplot + Sets a reference between this trace's data coordinates + and a ternary subplot. If "ternary" (the default + value), the data refer to `layout.ternary`. If + "ternary2", the data refer to `layout.ternary2`, and so + on. + sum + The number each triplet should sum to, if only two of + `a`, `b`, and `c` are provided. This overrides + `ternary.sum` to normalize this specific trace, but + does not affect the values displayed on the axes. 0 (or + missing) means to use ternary.sum + text + Sets text elements associated with each (a,b,c) point. + If a single string, the same string appears over all + the data points. If an array of strings, the items are + mapped in order to the the data points in (a,b,c). If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textfont + Sets the text font. + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `a`, `b`, `c` and `text`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.scatterternary.Unselected` + instance or dict with compatible properties + 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). + + Returns + ------- + Scatterternary + """ + super().__init__("scatterternary") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Scatterternary +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Scatterternary`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("a", arg, a) + self._set_property("asrc", arg, asrc) + self._set_property("b", arg, b) + self._set_property("bsrc", arg, bsrc) + self._set_property("c", arg, c) + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("csrc", arg, csrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("fill", arg, fill) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("mode", arg, mode) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("subplot", arg, subplot) + self._set_property("sum", arg, sum) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + + self._props["type"] = "scatterternary" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_splom.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_splom.py new file mode 100644 index 0000000..6dda185 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_splom.py @@ -0,0 +1,1520 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Splom(_BaseTraceType): + _parent_path_str = "" + _path_str = "splom" + _valid_props = { + "customdata", + "customdatasrc", + "diagonal", + "dimensiondefaults", + "dimensions", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "marker", + "meta", + "metasrc", + "name", + "opacity", + "selected", + "selectedpoints", + "showlegend", + "showlowerhalf", + "showupperhalf", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "xaxes", + "xhoverformat", + "yaxes", + "yhoverformat", + } + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def diagonal(self): + """ + The 'diagonal' property is an instance of Diagonal + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Diagonal` + - A dict of string/value properties that will be passed + to the Diagonal constructor + + Returns + ------- + plotly.graph_objs.splom.Diagonal + """ + return self["diagonal"] + + @diagonal.setter + def diagonal(self, val): + self["diagonal"] = val + + @property + def dimensions(self): + """ + The 'dimensions' property is a tuple of instances of + Dimension that may be specified as: + - A list or tuple of instances of plotly.graph_objs.splom.Dimension + - A list or tuple of dicts of string/value properties that + will be passed to the Dimension constructor + + Returns + ------- + tuple[plotly.graph_objs.splom.Dimension] + """ + return self["dimensions"] + + @dimensions.setter + def dimensions(self, val): + self["dimensions"] = val + + @property + def dimensiondefaults(self): + """ + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the default + property values to use for elements of splom.dimensions + + The 'dimensiondefaults' property is an instance of Dimension + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Dimension` + - A dict of string/value properties that will be passed + to the Dimension constructor + + Returns + ------- + plotly.graph_objs.splom.Dimension + """ + return self["dimensiondefaults"] + + @dimensiondefaults.setter + def dimensiondefaults(self, val): + self["dimensiondefaults"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.splom.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.splom.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.splom.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.splom.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showlowerhalf(self): + """ + Determines whether or not subplots on the lower half from the + diagonal are displayed. + + The 'showlowerhalf' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlowerhalf"] + + @showlowerhalf.setter + def showlowerhalf(self, val): + self["showlowerhalf"] = val + + @property + def showupperhalf(self): + """ + Determines whether or not subplots on the upper half from the + diagonal are displayed. + + The 'showupperhalf' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showupperhalf"] + + @showupperhalf.setter + def showupperhalf(self, val): + self["showupperhalf"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.splom.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair to appear on + hover. If a single string, the same string appears over all the + data points. If an array of string, the items are mapped in + order to the this trace's (x,y) coordinates. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.splom.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def xaxes(self): + """ + Sets the list of x axes corresponding to dimensions of this + splom trace. By default, a splom will match the first N xaxes + where N is the number of input dimensions. Note that, in case + where `diagonal.visible` is false and `showupperhalf` or + `showlowerhalf` is false, this splom trace will generate one + less x-axis and one less y-axis. + + The 'xaxes' property is an info array that may be specified as: + * a list of elements where: + The 'xaxes[i]' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + list + """ + return self["xaxes"] + + @xaxes.setter + def xaxes(self, val): + self["xaxes"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def yaxes(self): + """ + Sets the list of y axes corresponding to dimensions of this + splom trace. By default, a splom will match the first N yaxes + where N is the number of input dimensions. Note that, in case + where `diagonal.visible` is false and `showupperhalf` or + `showlowerhalf` is false, this splom trace will generate one + less x-axis and one less y-axis. + + The 'yaxes' property is an info array that may be specified as: + * a list of elements where: + The 'yaxes[i]' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + list + """ + return self["yaxes"] + + @yaxes.setter + def yaxes(self, val): + self["yaxes"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + diagonal + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties + dimensions + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the + default property values to use for elements of + splom.dimensions + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.splom.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower half + from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper half + from the diagonal are displayed. + stream + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair to + appear on hover. If a single string, the same string + appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties + 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). + xaxes + Sets the list of x axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N xaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + yaxes + Sets the list of y axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N yaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + """ + + def __init__( + self, + arg=None, + customdata=None, + customdatasrc=None, + diagonal=None, + dimensions=None, + dimensiondefaults=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + marker=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + selected=None, + selectedpoints=None, + showlegend=None, + showlowerhalf=None, + showupperhalf=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + xaxes=None, + xhoverformat=None, + yaxes=None, + yhoverformat=None, + **kwargs, + ): + """ + Construct a new Splom object + + Splom traces generate scatter plot matrix visualizations. Each + splom `dimensions` items correspond to a generated axis. Values + for each of those dimensions are set in `dimensions[i].values`. + Splom traces support all `scattergl` marker style attributes. + Specify `layout.grid` attributes and/or layout x-axis and + y-axis attributes for more control over the axis positioning + and style. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Splom` + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + diagonal + :class:`plotly.graph_objects.splom.Diagonal` instance + or dict with compatible properties + dimensions + A tuple of + :class:`plotly.graph_objects.splom.Dimension` instances + or dicts with compatible properties + dimensiondefaults + When used in a template (as + layout.template.data.splom.dimensiondefaults), sets the + default property values to use for elements of + splom.dimensions + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.splom.Hoverlabel` instance + or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.splom.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + marker + :class:`plotly.graph_objects.splom.Marker` instance or + dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + selected + :class:`plotly.graph_objects.splom.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showlowerhalf + Determines whether or not subplots on the lower half + from the diagonal are displayed. + showupperhalf + Determines whether or not subplots on the upper half + from the diagonal are displayed. + stream + :class:`plotly.graph_objects.splom.Stream` instance or + dict with compatible properties + text + Sets text elements associated with each (x,y) pair to + appear on hover. If a single string, the same string + appears over all the data points. If an array of + string, the items are mapped in order to the this + trace's (x,y) coordinates. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.splom.Unselected` instance + or dict with compatible properties + 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). + xaxes + Sets the list of x axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N xaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + yaxes + Sets the list of y axes corresponding to dimensions of + this splom trace. By default, a splom will match the + first N yaxes where N is the number of input + dimensions. Note that, in case where `diagonal.visible` + is false and `showupperhalf` or `showlowerhalf` is + false, this splom trace will generate one less x-axis + and one less y-axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + + Returns + ------- + Splom + """ + super().__init__("splom") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Splom +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Splom`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("diagonal", arg, diagonal) + self._set_property("dimensions", arg, dimensions) + self._set_property("dimensiondefaults", arg, dimensiondefaults) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("marker", arg, marker) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("showlowerhalf", arg, showlowerhalf) + self._set_property("showupperhalf", arg, showupperhalf) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("xaxes", arg, xaxes) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("yaxes", arg, yaxes) + self._set_property("yhoverformat", arg, yhoverformat) + + self._props["type"] = "splom" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_streamtube.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_streamtube.py new file mode 100644 index 0000000..de98ac3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_streamtube.py @@ -0,0 +1,2166 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Streamtube(_BaseTraceType): + _parent_path_str = "" + _path_str = "streamtube" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colorscale", + "customdata", + "customdatasrc", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lighting", + "lightposition", + "maxdisplayed", + "meta", + "metasrc", + "name", + "opacity", + "reversescale", + "scene", + "showlegend", + "showscale", + "sizeref", + "starts", + "stream", + "text", + "type", + "u", + "uhoverformat", + "uid", + "uirevision", + "usrc", + "v", + "vhoverformat", + "visible", + "vsrc", + "w", + "whoverformat", + "wsrc", + "x", + "xhoverformat", + "xsrc", + "y", + "yhoverformat", + "ysrc", + "z", + "zhoverformat", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here u/v/w norm) or the bounds set + in `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` + are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as u/v/w norm and if set, `cmin` must be set as + well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as u/v/w norm. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as u/v/w norm and if set, `cmax` must be set as + well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.streamtube.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'u', 'v', 'w', 'norm', 'divergence', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.streamtube.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `tubex`, `tubey`, + `tubez`, `tubeu`, `tubev`, `tubew`, `norm` and `divergence`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.streamtube.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.Lighting` + - A dict of string/value properties that will be passed + to the Lighting constructor + + Returns + ------- + plotly.graph_objs.streamtube.Lighting + """ + return self["lighting"] + + @lighting.setter + def lighting(self, val): + self["lighting"] = val + + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.Lightposition` + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Returns + ------- + plotly.graph_objs.streamtube.Lightposition + """ + return self["lightposition"] + + @lightposition.setter + def lightposition(self, val): + self["lightposition"] = val + + @property + def maxdisplayed(self): + """ + The maximum number of displayed segments in a streamtube. + + The 'maxdisplayed' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["maxdisplayed"] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self["maxdisplayed"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def sizeref(self): + """ + The scaling factor for the streamtubes. The default is 1, which + avoids two max divergence tubes from touching at adjacent + starting positions. + + The 'sizeref' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def starts(self): + """ + The 'starts' property is an instance of Starts + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.Starts` + - A dict of string/value properties that will be passed + to the Starts constructor + + Returns + ------- + plotly.graph_objs.streamtube.Starts + """ + return self["starts"] + + @starts.setter + def starts(self, val): + self["starts"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.streamtube.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets a text element associated with this trace. If trace + `hoverinfo` contains a "text" flag, this text element will be + seen in all hover labels. Note that streamtube traces do not + support array `text` values. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def u(self): + """ + Sets the x components of the vector field. + + The 'u' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["u"] + + @u.setter + def u(self, val): + self["u"] = val + + @property + def uhoverformat(self): + """ + Sets the hover text formatting rulefor `u` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'uhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uhoverformat"] + + @uhoverformat.setter + def uhoverformat(self, val): + self["uhoverformat"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def usrc(self): + """ + Sets the source reference on Chart Studio Cloud for `u`. + + The 'usrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["usrc"] + + @usrc.setter + def usrc(self, val): + self["usrc"] = val + + @property + def v(self): + """ + Sets the y components of the vector field. + + The 'v' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["v"] + + @v.setter + def v(self, val): + self["v"] = val + + @property + def vhoverformat(self): + """ + Sets the hover text formatting rulefor `v` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'vhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["vhoverformat"] + + @vhoverformat.setter + def vhoverformat(self, val): + self["vhoverformat"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def vsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `v`. + + The 'vsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["vsrc"] + + @vsrc.setter + def vsrc(self, val): + self["vsrc"] = val + + @property + def w(self): + """ + Sets the z components of the vector field. + + The 'w' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["w"] + + @w.setter + def w(self, val): + self["w"] = val + + @property + def whoverformat(self): + """ + Sets the hover text formatting rulefor `w` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'whoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["whoverformat"] + + @whoverformat.setter + def whoverformat(self, val): + self["whoverformat"] = val + + @property + def wsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `w`. + + The 'wsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["wsrc"] + + @wsrc.setter + def wsrc(self, val): + self["wsrc"] = val + + @property + def x(self): + """ + Sets the x coordinates of the vector field. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates of the vector field. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the z coordinates of the vector field. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `tubex`, `tubey`, `tubez`, `tubeu`, + `tubev`, `tubew`, `norm` and `divergence`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.streamtube.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizeref + The scaling factor for the streamtubes. The default is + 1, which avoids two max divergence tubes from touching + at adjacent starting positions. + starts + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties + text + Sets a text element associated with this trace. If + trace `hoverinfo` contains a "text" flag, this text + element will be seen in all hover labels. Note that + streamtube traces do not support array `text` values. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + customdata=None, + customdatasrc=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + maxdisplayed=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + sizeref=None, + starts=None, + stream=None, + text=None, + u=None, + uhoverformat=None, + uid=None, + uirevision=None, + usrc=None, + v=None, + vhoverformat=None, + visible=None, + vsrc=None, + w=None, + whoverformat=None, + wsrc=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Streamtube object + + Use a streamtube trace to visualize flow in a vector field. + Specify a vector field using 6 1D arrays of equal length, 3 + position arrays `x`, `y` and `z` and 3 vector component arrays + `u`, `v`, and `w`. By default, the tubes' starting positions + will be cut from the vector field's x-z plane at its minimum y + value. To specify your own starting position, use attributes + `starts.x`, `starts.y` and `starts.z`. The color is encoded by + the norm of (u, v, w), and the local radius by the divergence + of (u, v, w). + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Streamtube` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here u/v/w norm) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmin` + must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as u/v/w norm. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as u/v/w norm and if set, `cmax` + must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.streamtube.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.streamtube.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `tubex`, `tubey`, `tubez`, `tubeu`, + `tubev`, `tubew`, `norm` and `divergence`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.streamtube.Legendgrouptitl + e` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.streamtube.Lighting` + instance or dict with compatible properties + lightposition + :class:`plotly.graph_objects.streamtube.Lightposition` + instance or dict with compatible properties + maxdisplayed + The maximum number of displayed segments in a + streamtube. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + sizeref + The scaling factor for the streamtubes. The default is + 1, which avoids two max divergence tubes from touching + at adjacent starting positions. + starts + :class:`plotly.graph_objects.streamtube.Starts` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.streamtube.Stream` + instance or dict with compatible properties + text + Sets a text element associated with this trace. If + trace `hoverinfo` contains a "text" flag, this text + element will be seen in all hover labels. Note that + streamtube traces do not support array `text` values. + u + Sets the x components of the vector field. + uhoverformat + Sets the hover text formatting rulefor `u` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + usrc + Sets the source reference on Chart Studio Cloud for + `u`. + v + Sets the y components of the vector field. + vhoverformat + Sets the hover text formatting rulefor `v` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + 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). + vsrc + Sets the source reference on Chart Studio Cloud for + `v`. + w + Sets the z components of the vector field. + whoverformat + Sets the hover text formatting rulefor `w` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + wsrc + Sets the source reference on Chart Studio Cloud for + `w`. + x + Sets the x coordinates of the vector field. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates of the vector field. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates of the vector field. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Streamtube + """ + super().__init__("streamtube") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Streamtube +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Streamtube`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lighting", arg, lighting) + self._set_property("lightposition", arg, lightposition) + self._set_property("maxdisplayed", arg, maxdisplayed) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("sizeref", arg, sizeref) + self._set_property("starts", arg, starts) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("u", arg, u) + self._set_property("uhoverformat", arg, uhoverformat) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("usrc", arg, usrc) + self._set_property("v", arg, v) + self._set_property("vhoverformat", arg, vhoverformat) + self._set_property("visible", arg, visible) + self._set_property("vsrc", arg, vsrc) + self._set_property("w", arg, w) + self._set_property("whoverformat", arg, whoverformat) + self._set_property("wsrc", arg, wsrc) + self._set_property("x", arg, x) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "streamtube" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_sunburst.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_sunburst.py new file mode 100644 index 0000000..3f14360 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_sunburst.py @@ -0,0 +1,1760 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Sunburst(_BaseTraceType): + _parent_path_str = "" + _path_str = "sunburst" + _valid_props = { + "branchvalues", + "count", + "customdata", + "customdatasrc", + "domain", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextfont", + "insidetextorientation", + "labels", + "labelssrc", + "leaf", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "level", + "marker", + "maxdepth", + "meta", + "metasrc", + "name", + "opacity", + "outsidetextfont", + "parents", + "parentssrc", + "root", + "rotation", + "sort", + "stream", + "text", + "textfont", + "textinfo", + "textsrc", + "texttemplate", + "texttemplatesrc", + "type", + "uid", + "uirevision", + "values", + "valuessrc", + "visible", + } + + @property + def branchvalues(self): + """ + Determines how the items in `values` are summed. When set to + "total", items in `values` are taken to be value of all its + descendants. 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. + + The 'branchvalues' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['remainder', 'total'] + + Returns + ------- + Any + """ + return self["branchvalues"] + + @branchvalues.setter + def branchvalues(self, val): + self["branchvalues"] = val + + @property + def count(self): + """ + Determines default for `values` when it is not provided, by + inferring a 1 for each of the "leaves" and/or "branches", + otherwise 0. + + The 'count' property is a flaglist and may be specified + as a string containing: + - Any combination of ['branches', 'leaves'] joined with '+' characters + (e.g. 'branches+leaves') + + Returns + ------- + Any + """ + return self["count"] + + @count.setter + def count(self, val): + self["count"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.sunburst.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.sunburst.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `currentPath`, `root`, + `entry`, `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each sector. If a + single string, the same string appears for all data points. If + an array of string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` must contain a + "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `textinfo` lying inside the sector. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.sunburst.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def insidetextorientation(self): + """ + Controls the orientation of the text inside chart sectors. When + set to "auto", text may be oriented in any direction in order + to be as big as possible in the middle of a sector. The + "horizontal" option orients text to be parallel with the bottom + of the chart, and may make text smaller in order to achieve + that goal. The "radial" option orients text along the radius of + the sector. The "tangential" option orients text perpendicular + to the radius of the sector. + + The 'insidetextorientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['horizontal', 'radial', 'tangential', 'auto'] + + Returns + ------- + Any + """ + return self["insidetextorientation"] + + @insidetextorientation.setter + def insidetextorientation(self, val): + self["insidetextorientation"] = val + + @property + def labels(self): + """ + Sets the labels of each of the sectors. + + The 'labels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["labels"] + + @labels.setter + def labels(self, val): + self["labels"] = val + + @property + def labelssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `labels`. + + The 'labelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelssrc"] + + @labelssrc.setter + def labelssrc(self, val): + self["labelssrc"] = val + + @property + def leaf(self): + """ + The 'leaf' property is an instance of Leaf + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Leaf` + - A dict of string/value properties that will be passed + to the Leaf constructor + + Returns + ------- + plotly.graph_objs.sunburst.Leaf + """ + return self["leaf"] + + @leaf.setter + def leaf(self, val): + self["leaf"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.sunburst.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def level(self): + """ + Sets the level from which this trace hierarchy is rendered. Set + `level` to `''` to start from the root node in the hierarchy. + Must be an "id" if `ids` is filled in, otherwise plotly + attempts to find a matching item in `labels`. + + The 'level' property accepts values of any type + + Returns + ------- + Any + """ + return self["level"] + + @level.setter + def level(self, val): + self["level"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.sunburst.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def maxdepth(self): + """ + Sets the number of rendered sectors from any given `level`. Set + `maxdepth` to "-1" to render all the levels in the hierarchy. + + The 'maxdepth' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["maxdepth"] + + @maxdepth.setter + def maxdepth(self, val): + self["maxdepth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `textinfo` lying outside the sector. + This option refers to the root of the hierarchy presented at + the center of a sunburst graph. Please note that if a hierarchy + has multiple root nodes, this option won't have any effect and + `insidetextfont` would be used. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.sunburst.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def parents(self): + """ + Sets the parent sectors for each of the sectors. Empty string + items '' are understood to reference the root node in the + hierarchy. If `ids` is filled, `parents` items are understood + to be "ids" themselves. When `ids` is not set, plotly attempts + to find matching items in `labels`, but beware they must be + unique. + + The 'parents' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["parents"] + + @parents.setter + def parents(self, val): + self["parents"] = val + + @property + def parentssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `parents`. + + The 'parentssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["parentssrc"] + + @parentssrc.setter + def parentssrc(self, val): + self["parentssrc"] = val + + @property + def root(self): + """ + The 'root' property is an instance of Root + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Root` + - A dict of string/value properties that will be passed + to the Root constructor + + Returns + ------- + plotly.graph_objs.sunburst.Root + """ + return self["root"] + + @root.setter + def root(self, val): + self["root"] = val + + @property + def rotation(self): + """ + Rotates the whole diagram counterclockwise by some angle. By + default the first slice starts at 3 o'clock. + + The 'rotation' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["rotation"] + + @rotation.setter + def rotation(self, val): + self["rotation"] = val + + @property + def sort(self): + """ + Determines whether or not the sectors are reordered from + largest to smallest. + + The 'sort' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["sort"] + + @sort.setter + def sort(self, val): + self["sort"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.sunburst.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each sector. If trace + `textinfo` contains a "text" flag, these elements will be seen + on the chart. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the font used for `textinfo`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.sunburst.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables + `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, + `percentParent`, `label` and `value`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def values(self): + """ + Sets the values associated with each of the sectors. Use with + `branchvalues` to determine how the values are summed. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sunburst.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented at the center of a sunburst graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + root + :class:`plotly.graph_objects.sunburst.Root` instance or + dict with compatible properties + rotation + Rotates the whole diagram counterclockwise by some + angle. By default the first slice starts at 3 o'clock. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + """ + + def __init__( + self, + arg=None, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + insidetextorientation=None, + labels=None, + labelssrc=None, + leaf=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + root=None, + rotation=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Sunburst object + + Visualize hierarchal data spanning outward radially from root + to leaves. The sunburst sectors are determined by the entries + in "labels" or "ids" and in "parents". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Sunburst` + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.sunburst.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.sunburst.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + insidetextorientation + Controls the orientation of the text inside chart + sectors. When set to "auto", text may be oriented in + any direction in order to be as big as possible in the + middle of a sector. The "horizontal" option orients + text to be parallel with the bottom of the chart, and + may make text smaller in order to achieve that goal. + The "radial" option orients text along the radius of + the sector. The "tangential" option orients text + perpendicular to the radius of the sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + leaf + :class:`plotly.graph_objects.sunburst.Leaf` instance or + dict with compatible properties + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.sunburst.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.sunburst.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented at the center of a sunburst graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + root + :class:`plotly.graph_objects.sunburst.Root` instance or + dict with compatible properties + rotation + Rotates the whole diagram counterclockwise by some + angle. By default the first slice starts at 3 o'clock. + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.sunburst.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + + Returns + ------- + Sunburst + """ + super().__init__("sunburst") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Sunburst +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Sunburst`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("branchvalues", arg, branchvalues) + self._set_property("count", arg, count) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("domain", arg, domain) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("insidetextorientation", arg, insidetextorientation) + self._set_property("labels", arg, labels) + self._set_property("labelssrc", arg, labelssrc) + self._set_property("leaf", arg, leaf) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("level", arg, level) + self._set_property("marker", arg, marker) + self._set_property("maxdepth", arg, maxdepth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("parents", arg, parents) + self._set_property("parentssrc", arg, parentssrc) + self._set_property("root", arg, root) + self._set_property("rotation", arg, rotation) + self._set_property("sort", arg, sort) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + + self._props["type"] = "sunburst" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_surface.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_surface.py new file mode 100644 index 0000000..a2d65c3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_surface.py @@ -0,0 +1,2138 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Surface(_BaseTraceType): + _parent_path_str = "" + _path_str = "surface" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colorscale", + "connectgaps", + "contours", + "customdata", + "customdatasrc", + "hidesurface", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lighting", + "lightposition", + "meta", + "metasrc", + "name", + "opacity", + "opacityscale", + "reversescale", + "scene", + "showlegend", + "showscale", + "stream", + "surfacecolor", + "surfacecolorsrc", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "visible", + "x", + "xcalendar", + "xhoverformat", + "xsrc", + "y", + "ycalendar", + "yhoverformat", + "ysrc", + "z", + "zcalendar", + "zhoverformat", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here z or surfacecolor) or the + bounds set in `cmin` and `cmax` Defaults to `false` when `cmin` + and `cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as z or surfacecolor and if set, `cmin` must be set + as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as z or surfacecolor. Has no effect when `cauto` is + `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as z or surfacecolor and if set, `cmax` must be set + as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.surface.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def connectgaps(self): + """ + Determines whether or not gaps (i.e. {nan} or missing values) + in the `z` data are filled in. + + The 'connectgaps' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["connectgaps"] + + @connectgaps.setter + def connectgaps(self, val): + self["connectgaps"] = val + + @property + def contours(self): + """ + The 'contours' property is an instance of Contours + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.Contours` + - A dict of string/value properties that will be passed + to the Contours constructor + + Returns + ------- + plotly.graph_objs.surface.Contours + """ + return self["contours"] + + @contours.setter + def contours(self, val): + self["contours"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def hidesurface(self): + """ + Determines whether or not a surface is drawn. For example, set + `hidesurface` to False `contours.x.show` to True and + `contours.y.show` to True to draw a wire frame plot. + + The 'hidesurface' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["hidesurface"] + + @hidesurface.setter + def hidesurface(self, val): + self["hidesurface"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.surface.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.surface.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.Lighting` + - A dict of string/value properties that will be passed + to the Lighting constructor + + Returns + ------- + plotly.graph_objs.surface.Lighting + """ + return self["lighting"] + + @lighting.setter + def lighting(self, val): + self["lighting"] = val + + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.Lightposition` + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Returns + ------- + plotly.graph_objs.surface.Lightposition + """ + return self["lightposition"] + + @lightposition.setter + def lightposition(self, val): + self["lightposition"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacityscale(self): + """ + Sets the opacityscale. The opacityscale must be an array + containing arrays mapping a normalized value to an opacity + value. At minimum, a mapping for the lowest (0) and highest (1) + values are required. For example, `[[0, 1], [0.5, 0.2], [1, + 1]]` means that higher/lower values would have higher opacity + values and those in the middle would be more transparent + Alternatively, `opacityscale` may be a palette name string of + the following list: 'min', 'max', 'extremes' and 'uniform'. The + default is 'uniform'. + + The 'opacityscale' property accepts values of any type + + Returns + ------- + Any + """ + return self["opacityscale"] + + @opacityscale.setter + def opacityscale(self, val): + self["opacityscale"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.surface.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def surfacecolor(self): + """ + Sets the surface color values, used for setting a color scale + independent of `z`. + + The 'surfacecolor' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["surfacecolor"] + + @surfacecolor.setter + def surfacecolor(self, val): + self["surfacecolor"] = val + + @property + def surfacecolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `surfacecolor`. + + The 'surfacecolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["surfacecolorsrc"] + + @surfacecolorsrc.setter + def surfacecolorsrc(self, val): + self["surfacecolorsrc"] = val + + @property + def text(self): + """ + Sets the text elements associated with each z value. If trace + `hoverinfo` contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xcalendar(self): + """ + Sets the calendar system to use with `x` date data. + + The 'xcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["xcalendar"] + + @xcalendar.setter + def xcalendar(self, val): + self["xcalendar"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def ycalendar(self): + """ + Sets the calendar system to use with `y` date data. + + The 'ycalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["ycalendar"] + + @ycalendar.setter + def ycalendar(self, val): + self["ycalendar"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the z coordinates. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zcalendar(self): + """ + Sets the calendar system to use with `z` date data. + + The 'zcalendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["zcalendar"] + + @zcalendar.setter + def zcalendar(self, val): + self["zcalendar"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here z or surfacecolor) + or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as z or surfacecolor. + Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + contours + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hidesurface + Determines whether or not a surface is drawn. For + example, set `hidesurface` to False `contours.x.show` + to True and `contours.y.show` to True to draw a wire + frame plot. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.surface.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties + surfacecolor + Sets the surface color values, used for setting a color + scale independent of `z`. + surfacecolorsrc + Sets the source reference on Chart Studio Cloud for + `surfacecolor`. + text + Sets the text elements associated with each z value. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + connectgaps=None, + contours=None, + customdata=None, + customdatasrc=None, + hidesurface=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + opacityscale=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + stream=None, + surfacecolor=None, + surfacecolorsrc=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + visible=None, + x=None, + xcalendar=None, + xhoverformat=None, + xsrc=None, + y=None, + ycalendar=None, + yhoverformat=None, + ysrc=None, + z=None, + zcalendar=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Surface object + + The data the describes the coordinates of the surface is set in + `z`. Data in `z` should be a 2D list. Coordinates in `x` and + `y` can either be 1D lists or 2D lists (e.g. to graph + parametric surfaces). If not provided in `x` and `y`, the x and + y coordinates are assumed to be linear starting at 0 with a + unit step. The color scale corresponds to the `z` values by + default. For custom color scales, use `surfacecolor` which + should be a 2D list, where its bounds can be controlled using + `cmin` and `cmax`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Surface` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here z or surfacecolor) + or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as z or surfacecolor. + Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as z or surfacecolor and if set, + `cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.surface.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + connectgaps + Determines whether or not gaps (i.e. {nan} or missing + values) in the `z` data are filled in. + contours + :class:`plotly.graph_objects.surface.Contours` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hidesurface + Determines whether or not a surface is drawn. For + example, set `hidesurface` to False `contours.x.show` + to True and `contours.y.show` to True to draw a wire + frame plot. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.surface.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.surface.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.surface.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.surface.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + stream + :class:`plotly.graph_objects.surface.Stream` instance + or dict with compatible properties + surfacecolor + Sets the surface color values, used for setting a color + scale independent of `z`. + surfacecolorsrc + Sets the source reference on Chart Studio Cloud for + `surfacecolor`. + text + Sets the text elements associated with each z value. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + x + Sets the x coordinates. + xcalendar + Sets the calendar system to use with `x` date data. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + ycalendar + Sets the calendar system to use with `y` date data. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z coordinates. + zcalendar + Sets the calendar system to use with `z` date data. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Surface + """ + super().__init__("surface") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Surface +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Surface`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("connectgaps", arg, connectgaps) + self._set_property("contours", arg, contours) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("hidesurface", arg, hidesurface) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lighting", arg, lighting) + self._set_property("lightposition", arg, lightposition) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("opacityscale", arg, opacityscale) + self._set_property("reversescale", arg, reversescale) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("stream", arg, stream) + self._set_property("surfacecolor", arg, surfacecolor) + self._set_property("surfacecolorsrc", arg, surfacecolorsrc) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xcalendar", arg, xcalendar) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("ycalendar", arg, ycalendar) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zcalendar", arg, zcalendar) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "surface" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_table.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_table.py new file mode 100644 index 0000000..3bf76e1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_table.py @@ -0,0 +1,908 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Table(_BaseTraceType): + _parent_path_str = "" + _path_str = "table" + _valid_props = { + "cells", + "columnorder", + "columnordersrc", + "columnwidth", + "columnwidthsrc", + "customdata", + "customdatasrc", + "domain", + "header", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "ids", + "idssrc", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "meta", + "metasrc", + "name", + "stream", + "type", + "uid", + "uirevision", + "visible", + } + + @property + def cells(self): + """ + The 'cells' property is an instance of Cells + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.Cells` + - A dict of string/value properties that will be passed + to the Cells constructor + + Returns + ------- + plotly.graph_objs.table.Cells + """ + return self["cells"] + + @cells.setter + def cells(self, val): + self["cells"] = val + + @property + def columnorder(self): + """ + Specifies the rendered order of the data columns; for example, + a value `2` at position `0` means that column index `0` in the + data will be rendered as the third column, as columns have an + index base of zero. + + The 'columnorder' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["columnorder"] + + @columnorder.setter + def columnorder(self, val): + self["columnorder"] = val + + @property + def columnordersrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `columnorder`. + + The 'columnordersrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["columnordersrc"] + + @columnordersrc.setter + def columnordersrc(self, val): + self["columnordersrc"] = val + + @property + def columnwidth(self): + """ + The width of columns expressed as a ratio. Columns fill the + available width in proportion of their specified column widths. + + The 'columnwidth' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["columnwidth"] + + @columnwidth.setter + def columnwidth(self, val): + self["columnwidth"] = val + + @property + def columnwidthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `columnwidth`. + + The 'columnwidthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["columnwidthsrc"] + + @columnwidthsrc.setter + def columnwidthsrc(self, val): + self["columnwidthsrc"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.table.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def header(self): + """ + The 'header' property is an instance of Header + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.Header` + - A dict of string/value properties that will be passed + to the Header constructor + + Returns + ------- + plotly.graph_objs.table.Header + """ + return self["header"] + + @header.setter + def header(self, val): + self["header"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.table.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.table.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.table.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + cells + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties + columnorder + Specifies the rendered order of the data columns; for + example, a value `2` at position `0` means that column + index `0` in the data will be rendered as the third + column, as columns have an index base of zero. + columnordersrc + Sets the source reference on Chart Studio Cloud for + `columnorder`. + columnwidth + The width of columns expressed as a ratio. Columns fill + the available width in proportion of their specified + column widths. + columnwidthsrc + Sets the source reference on Chart Studio Cloud for + `columnwidth`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties + header + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.table.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + stream + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + """ + + def __init__( + self, + arg=None, + cells=None, + columnorder=None, + columnordersrc=None, + columnwidth=None, + columnwidthsrc=None, + customdata=None, + customdatasrc=None, + domain=None, + header=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + ids=None, + idssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + meta=None, + metasrc=None, + name=None, + stream=None, + uid=None, + uirevision=None, + visible=None, + **kwargs, + ): + """ + Construct a new Table object + + Table view for detailed data viewing. The data are arranged in + a grid of rows and columns. Most styling can be specified for + columns, rows or individual cells. Table is using a column- + major order, ie. the grid is represented as a vector of column + vectors. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Table` + cells + :class:`plotly.graph_objects.table.Cells` instance or + dict with compatible properties + columnorder + Specifies the rendered order of the data columns; for + example, a value `2` at position `0` means that column + index `0` in the data will be rendered as the third + column, as columns have an index base of zero. + columnordersrc + Sets the source reference on Chart Studio Cloud for + `columnorder`. + columnwidth + The width of columns expressed as a ratio. Columns fill + the available width in proportion of their specified + column widths. + columnwidthsrc + Sets the source reference on Chart Studio Cloud for + `columnwidth`. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.table.Domain` instance or + dict with compatible properties + header + :class:`plotly.graph_objects.table.Header` instance or + dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.table.Hoverlabel` instance + or dict with compatible properties + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.table.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + stream + :class:`plotly.graph_objects.table.Stream` instance or + dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + + Returns + ------- + Table + """ + super().__init__("table") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Table +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Table`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("cells", arg, cells) + self._set_property("columnorder", arg, columnorder) + self._set_property("columnordersrc", arg, columnordersrc) + self._set_property("columnwidth", arg, columnwidth) + self._set_property("columnwidthsrc", arg, columnwidthsrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("domain", arg, domain) + self._set_property("header", arg, header) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("stream", arg, stream) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + + self._props["type"] = "table" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_treemap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_treemap.py new file mode 100644 index 0000000..69dbd3b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_treemap.py @@ -0,0 +1,1738 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Treemap(_BaseTraceType): + _parent_path_str = "" + _path_str = "treemap" + _valid_props = { + "branchvalues", + "count", + "customdata", + "customdatasrc", + "domain", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "insidetextfont", + "labels", + "labelssrc", + "legend", + "legendgrouptitle", + "legendrank", + "legendwidth", + "level", + "marker", + "maxdepth", + "meta", + "metasrc", + "name", + "opacity", + "outsidetextfont", + "parents", + "parentssrc", + "pathbar", + "root", + "sort", + "stream", + "text", + "textfont", + "textinfo", + "textposition", + "textsrc", + "texttemplate", + "texttemplatesrc", + "tiling", + "type", + "uid", + "uirevision", + "values", + "valuessrc", + "visible", + } + + @property + def branchvalues(self): + """ + Determines how the items in `values` are summed. When set to + "total", items in `values` are taken to be value of all its + descendants. 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. + + The 'branchvalues' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['remainder', 'total'] + + Returns + ------- + Any + """ + return self["branchvalues"] + + @branchvalues.setter + def branchvalues(self, val): + self["branchvalues"] = val + + @property + def count(self): + """ + Determines default for `values` when it is not provided, by + inferring a 1 for each of the "leaves" and/or "branches", + otherwise 0. + + The 'count' property is a flaglist and may be specified + as a string containing: + - Any combination of ['branches', 'leaves'] joined with '+' characters + (e.g. 'branches+leaves') + + Returns + ------- + Any + """ + return self["count"] + + @count.setter + def count(self, val): + self["count"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.treemap.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'name', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.treemap.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `currentPath`, `root`, + `entry`, `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each sector. If a + single string, the same string appears for all data points. If + an array of string, the items are mapped in order of this + trace's sectors. To be seen, trace `hoverinfo` must contain a + "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `textinfo` lying inside the sector. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.treemap.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def labels(self): + """ + Sets the labels of each of the sectors. + + The 'labels' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["labels"] + + @labels.setter + def labels(self, val): + self["labels"] = val + + @property + def labelssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `labels`. + + The 'labelssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelssrc"] + + @labelssrc.setter + def labelssrc(self, val): + self["labelssrc"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.treemap.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def level(self): + """ + Sets the level from which this trace hierarchy is rendered. Set + `level` to `''` to start from the root node in the hierarchy. + Must be an "id" if `ids` is filled in, otherwise plotly + attempts to find a matching item in `labels`. + + The 'level' property accepts values of any type + + Returns + ------- + Any + """ + return self["level"] + + @level.setter + def level(self, val): + self["level"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.treemap.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def maxdepth(self): + """ + Sets the number of rendered sectors from any given `level`. Set + `maxdepth` to "-1" to render all the levels in the hierarchy. + + The 'maxdepth' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["maxdepth"] + + @maxdepth.setter + def maxdepth(self, val): + self["maxdepth"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `textinfo` lying outside the sector. + This option refers to the root of the hierarchy presented on + top left corner of a treemap graph. Please note that if a + hierarchy has multiple root nodes, this option won't have any + effect and `insidetextfont` would be used. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.treemap.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def parents(self): + """ + Sets the parent sectors for each of the sectors. Empty string + items '' are understood to reference the root node in the + hierarchy. If `ids` is filled, `parents` items are understood + to be "ids" themselves. When `ids` is not set, plotly attempts + to find matching items in `labels`, but beware they must be + unique. + + The 'parents' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["parents"] + + @parents.setter + def parents(self, val): + self["parents"] = val + + @property + def parentssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `parents`. + + The 'parentssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["parentssrc"] + + @parentssrc.setter + def parentssrc(self, val): + self["parentssrc"] = val + + @property + def pathbar(self): + """ + The 'pathbar' property is an instance of Pathbar + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Pathbar` + - A dict of string/value properties that will be passed + to the Pathbar constructor + + Returns + ------- + plotly.graph_objs.treemap.Pathbar + """ + return self["pathbar"] + + @pathbar.setter + def pathbar(self, val): + self["pathbar"] = val + + @property + def root(self): + """ + The 'root' property is an instance of Root + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Root` + - A dict of string/value properties that will be passed + to the Root constructor + + Returns + ------- + plotly.graph_objs.treemap.Root + """ + return self["root"] + + @root.setter + def root(self, val): + self["root"] = val + + @property + def sort(self): + """ + Determines whether or not the sectors are reordered from + largest to smallest. + + The 'sort' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["sort"] + + @sort.setter + def sort(self, val): + self["sort"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.treemap.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each sector. If trace + `textinfo` contains a "text" flag, these elements will be seen + on the chart. If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in the + hover labels. + + The 'text' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the font used for `textinfo`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.treemap.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'value', 'current path', 'percent root', 'percent entry', 'percent parent'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables + `currentPath`, `root`, `entry`, `percentRoot`, `percentEntry`, + `percentParent`, `label` and `value`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def tiling(self): + """ + The 'tiling' property is an instance of Tiling + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.Tiling` + - A dict of string/value properties that will be passed + to the Tiling constructor + + Returns + ------- + plotly.graph_objs.treemap.Tiling + """ + return self["tiling"] + + @tiling.setter + def tiling(self, val): + self["tiling"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def values(self): + """ + Sets the values associated with each of the sectors. Use with + `branchvalues` to determine how the values are summed. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.treemap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.treemap.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + """ + + def __init__( + self, + arg=None, + branchvalues=None, + count=None, + customdata=None, + customdatasrc=None, + domain=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + insidetextfont=None, + labels=None, + labelssrc=None, + legend=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + level=None, + marker=None, + maxdepth=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + outsidetextfont=None, + parents=None, + parentssrc=None, + pathbar=None, + root=None, + sort=None, + stream=None, + text=None, + textfont=None, + textinfo=None, + textposition=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + tiling=None, + uid=None, + uirevision=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Treemap object + + Visualize hierarchal data from leaves (and/or outer branches) + towards root with rectangles. The treemap sectors are + determined by the entries in "labels" or "ids" and in + "parents". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.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. 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. + count + Determines default for `values` when it is not + provided, by inferring a 1 for each of the "leaves" + and/or "branches", otherwise 0. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + domain + :class:`plotly.graph_objects.treemap.Domain` instance + or dict with compatible properties + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.treemap.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry` and `percentParent`. + Anything contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each sector. + If a single string, the same string appears for all + data points. If an array of string, the items are + mapped in order of this trace's sectors. To be seen, + trace `hoverinfo` must contain a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + insidetextfont + Sets the font used for `textinfo` lying inside the + sector. + labels + Sets the labels of each of the sectors. + labelssrc + Sets the source reference on Chart Studio Cloud for + `labels`. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgrouptitle + :class:`plotly.graph_objects.treemap.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + level + Sets the level from which this trace hierarchy is + rendered. Set `level` to `''` to start from the root + node in the hierarchy. Must be an "id" if `ids` is + filled in, otherwise plotly attempts to find a matching + item in `labels`. + marker + :class:`plotly.graph_objects.treemap.Marker` instance + or dict with compatible properties + maxdepth + Sets the number of rendered sectors from any given + `level`. Set `maxdepth` to "-1" to render all the + levels in the hierarchy. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the trace. + outsidetextfont + Sets the font used for `textinfo` lying outside the + sector. This option refers to the root of the hierarchy + presented on top left corner of a treemap graph. Please + note that if a hierarchy has multiple root nodes, this + option won't have any effect and `insidetextfont` would + be used. + parents + Sets the parent sectors for each of the sectors. Empty + string items '' are understood to reference the root + node in the hierarchy. If `ids` is filled, `parents` + items are understood to be "ids" themselves. When `ids` + is not set, plotly attempts to find matching items in + `labels`, but beware they must be unique. + parentssrc + Sets the source reference on Chart Studio Cloud for + `parents`. + pathbar + :class:`plotly.graph_objects.treemap.Pathbar` instance + or dict with compatible properties + root + :class:`plotly.graph_objects.treemap.Root` instance or + dict with compatible properties + sort + Determines whether or not the sectors are reordered + from largest to smallest. + stream + :class:`plotly.graph_objects.treemap.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each sector. If + trace `textinfo` contains a "text" flag, these elements + will be seen on the chart. If trace `hoverinfo` + contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + textfont + Sets the font used for `textinfo`. + textinfo + Determines which trace information appear on the graph. + textposition + Sets the positions of the `text` elements. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `currentPath`, `root`, `entry`, + `percentRoot`, `percentEntry`, `percentParent`, `label` + and `value`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + tiling + :class:`plotly.graph_objects.treemap.Tiling` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + values + Sets the values associated with each of the sectors. + Use with `branchvalues` to determine how the values are + summed. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + 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). + + Returns + ------- + Treemap + """ + super().__init__("treemap") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Treemap +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Treemap`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("branchvalues", arg, branchvalues) + self._set_property("count", arg, count) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("domain", arg, domain) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("labels", arg, labels) + self._set_property("labelssrc", arg, labelssrc) + self._set_property("legend", arg, legend) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("level", arg, level) + self._set_property("marker", arg, marker) + self._set_property("maxdepth", arg, maxdepth) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("parents", arg, parents) + self._set_property("parentssrc", arg, parentssrc) + self._set_property("pathbar", arg, pathbar) + self._set_property("root", arg, root) + self._set_property("sort", arg, sort) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textposition", arg, textposition) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("tiling", arg, tiling) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + + self._props["type"] = "treemap" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_violin.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_violin.py new file mode 100644 index 0000000..943a5f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_violin.py @@ -0,0 +1,2264 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Violin(_BaseTraceType): + _parent_path_str = "" + _path_str = "violin" + _valid_props = { + "alignmentgroup", + "bandwidth", + "box", + "customdata", + "customdatasrc", + "fillcolor", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hoveron", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "jitter", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "marker", + "meanline", + "meta", + "metasrc", + "name", + "offsetgroup", + "opacity", + "orientation", + "pointpos", + "points", + "quartilemethod", + "scalegroup", + "scalemode", + "selected", + "selectedpoints", + "showlegend", + "side", + "span", + "spanmode", + "stream", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "unselected", + "visible", + "width", + "x", + "x0", + "xaxis", + "xhoverformat", + "xsrc", + "y", + "y0", + "yaxis", + "yhoverformat", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def bandwidth(self): + """ + Sets the bandwidth used to compute the kernel density estimate. + By default, the bandwidth is determined by Silverman's rule of + thumb. + + The 'bandwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["bandwidth"] + + @bandwidth.setter + def bandwidth(self, val): + self["bandwidth"] = val + + @property + def box(self): + """ + The 'box' property is an instance of Box + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Box` + - A dict of string/value properties that will be passed + to the Box constructor + + Returns + ------- + plotly.graph_objs.violin.Box + """ + return self["box"] + + @box.setter + def box(self, val): + self["box"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.violin.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hoveron(self): + """ + Do the hover effects highlight individual violins or sample + points or the kernel density estimate or any combination of + them? + + The 'hoveron' property is a flaglist and may be specified + as a string containing: + - Any combination of ['violins', 'points', 'kde'] joined with '+' characters + (e.g. 'violins+points') + OR exactly one of ['all'] (e.g. 'all') + + Returns + ------- + Any + """ + return self["hoveron"] + + @hoveron.setter + def hoveron(self, val): + self["hoveron"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def jitter(self): + """ + Sets the amount of jitter in the sample points drawn. If 0, the + sample points align along the distribution axis. If 1, the + sample points are drawn in a random jitter of width equal to + the width of the violins. + + The 'jitter' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["jitter"] + + @jitter.setter + def jitter(self, val): + self["jitter"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.violin.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.violin.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.violin.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def meanline(self): + """ + The 'meanline' property is an instance of Meanline + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Meanline` + - A dict of string/value properties that will be passed + to the Meanline constructor + + Returns + ------- + plotly.graph_objs.violin.Meanline + """ + return self["meanline"] + + @meanline.setter + def meanline(self, val): + self["meanline"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. For violin traces, the name will also be used for + the position coordinate, if `x` and `x0` (`y` and `y0` if + horizontal) are missing and the position axis is categorical. + Note that the trace name is also used as a default value for + attribute `scalegroup` (please see its description for + details). + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Sets the orientation of the violin(s). If "v" ("h"), the + distribution is visualized along the vertical (horizontal). + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def pointpos(self): + """ + Sets the position of the sample points in relation to the + violins. If 0, the sample points are places over the center of + the violins. Positive (negative) values correspond to positions + to the right (left) for vertical violins and above (below) for + horizontal violins. + + The 'pointpos' property is a number and may be specified as: + - An int or float in the interval [-2, 2] + + Returns + ------- + int|float + """ + return self["pointpos"] + + @pointpos.setter + def pointpos(self, val): + self["pointpos"] = val + + @property + def points(self): + """ + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier points + are shown and points either less than 4*Q1-3*Q3 or greater than + 4*Q3-3*Q1 are highlighted (see `outliercolor`) If "all", all + sample points are shown If False, only the violins are shown + with no sample points. Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is set, + otherwise defaults to "outliers". + + The 'points' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'outliers', 'suspectedoutliers', False] + + Returns + ------- + Any + """ + return self["points"] + + @points.setter + def points(self, val): + self["points"] = val + + @property + def quartilemethod(self): + """ + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile for Q1 + and 75th percentile for Q3 as computed using method #10 (listed + on http://jse.amstat.org/v14n3/langford.html). The "exclusive" + method uses the median to divide the ordered dataset into two + halves if the sample is odd, it does not include the median in + either half - Q1 is then the median of the lower half and Q3 + the median of the upper half. The "inclusive" method also uses + the median to divide the ordered dataset into two halves but if + the sample is odd, it includes the median in both halves - Q1 + is then the median of the lower half and Q3 the median of the + upper half. + + The 'quartilemethod' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'exclusive', 'inclusive'] + + Returns + ------- + Any + """ + return self["quartilemethod"] + + @quartilemethod.setter + def quartilemethod(self, val): + self["quartilemethod"] = val + + @property + def scalegroup(self): + """ + If there are multiple violins that should be sized according to + to some metric (see `scalemode`), link them by providing a non- + empty group id here shared by every trace in the same group. If + a violin's `width` is undefined, `scalegroup` will default to + the trace's name. In this case, violins with the same names + will be linked together + + The 'scalegroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["scalegroup"] + + @scalegroup.setter + def scalegroup(self, val): + self["scalegroup"] = val + + @property + def scalemode(self): + """ + Sets the metric by which the width of each violin is + determined. "width" means each violin has the same (max) width + "count" means the violins are scaled by the number of sample + points making up each violin. + + The 'scalemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['width', 'count'] + + Returns + ------- + Any + """ + return self["scalemode"] + + @scalemode.setter + def scalemode(self, val): + self["scalemode"] = val + + @property + def selected(self): + """ + The 'selected' property is an instance of Selected + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Selected` + - A dict of string/value properties that will be passed + to the Selected constructor + + Returns + ------- + plotly.graph_objs.violin.Selected + """ + return self["selected"] + + @selected.setter + def selected(self, val): + self["selected"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def side(self): + """ + Determines on which side of the position value the density + function making up one half of a violin is plotted. Useful when + comparing two violin traces under "overlay" mode, where one + trace has `side` set to "positive" and the other to "negative". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['both', 'positive', 'negative'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def span(self): + """ + Sets the span in data space for which the density function will + be computed. Has an effect only when `spanmode` is set to + "manual". + + The 'span' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'span[0]' property accepts values of any type + (1) The 'span[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["span"] + + @span.setter + def span(self, val): + self["span"] = val + + @property + def spanmode(self): + """ + Sets the method by which the span in data space where the + density function will be computed. "soft" means the span goes + from the sample's minimum value minus two bandwidths to the + sample's maximum value plus two bandwidths. "hard" means the + span goes from the sample's minimum to its maximum value. For + custom span settings, use mode "manual" and fill in the `span` + attribute. + + The 'spanmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['soft', 'hard', 'manual'] + + Returns + ------- + Any + """ + return self["spanmode"] + + @spanmode.setter + def spanmode(self, val): + self["spanmode"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.violin.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets the text elements associated with each sample value. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def unselected(self): + """ + The 'unselected' property is an instance of Unselected + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.Unselected` + - A dict of string/value properties that will be passed + to the Unselected constructor + + Returns + ------- + plotly.graph_objs.violin.Unselected + """ + return self["unselected"] + + @unselected.setter + def unselected(self, val): + self["unselected"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width of the violin in data coordinates. If 0 (default + value) the width is automatically selected based on the + positions of other violin traces in the same subplot. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def x(self): + """ + Sets the x sample data or coordinates. See overview for more + info. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Sets the x coordinate for single-box traces or the starting + coordinate for multi-box traces set using q1/median/q3. See + overview for more info. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y sample data or coordinates. See overview for more + info. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Sets the y coordinate for single-box traces or the starting + coordinate for multi-box traces set using q1/median/q3. See + overview for more info. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + bandwidth + Sets the bandwidth used to compute the kernel density + estimate. By default, the bandwidth is determined by + Silverman's rule of thumb. + box + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual violins or + sample points or the kernel density estimate or any + combination of them? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the violins. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.violin.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties + meanline + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For violin traces, the name + will also be used for the position coordinate, if `x` + and `x0` (`y` and `y0` if horizontal) are missing and + the position axis is categorical. Note that the trace + name is also used as a default value for attribute + `scalegroup` (please see its description for details). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" ("h"), + the distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the violins. If 0, the sample points are places over + the center of the violins. Positive (negative) values + correspond to positions to the right (left) for + vertical violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the violins are shown with no sample + points. Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set, otherwise defaults to "outliers". + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + scalegroup + If there are multiple violins that should be sized + according to to some metric (see `scalemode`), link + them by providing a non-empty group id here shared by + every trace in the same group. If a violin's `width` is + undefined, `scalegroup` will default to the trace's + name. In this case, violins with the same names will be + linked together + scalemode + Sets the metric by which the width of each violin is + determined. "width" means each violin has the same + (max) width "count" means the violins are scaled by the + number of sample points making up each violin. + selected + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + side + Determines on which side of the position value the + density function making up one half of a violin is + plotted. Useful when comparing two violin traces under + "overlay" mode, where one trace has `side` set to + "positive" and the other to "negative". + span + Sets the span in data space for which the density + function will be computed. Has an effect only when + `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space where + the density function will be computed. "soft" means the + span goes from the sample's minimum value minus two + bandwidths to the sample's maximum value plus two + bandwidths. "hard" means the span goes from the + sample's minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the `span` + attribute. + stream + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties + 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). + width + Sets the width of the violin in data coordinates. If 0 + (default value) the width is automatically selected + based on the positions of other violin traces in the + same subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + bandwidth=None, + box=None, + customdata=None, + customdatasrc=None, + fillcolor=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hoveron=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + jitter=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + marker=None, + meanline=None, + meta=None, + metasrc=None, + name=None, + offsetgroup=None, + opacity=None, + orientation=None, + pointpos=None, + points=None, + quartilemethod=None, + scalegroup=None, + scalemode=None, + selected=None, + selectedpoints=None, + showlegend=None, + side=None, + span=None, + spanmode=None, + stream=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + unselected=None, + visible=None, + width=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Violin object + + In vertical (horizontal) violin plots, statistics are computed + using `y` (`x`) values. By supplying an `x` (`y`) array, one + violin per distinct x (y) value is drawn If no `x` (`y`) list + is provided, a single violin is drawn. That violin position is + then positioned with with `name` or with `x0` (`y0`) if + provided. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Violin` + 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. + bandwidth + Sets the bandwidth used to compute the kernel density + estimate. By default, the bandwidth is determined by + Silverman's rule of thumb. + box + :class:`plotly.graph_objects.violin.Box` instance or + dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.violin.Hoverlabel` + instance or dict with compatible properties + hoveron + Do the hover effects highlight individual violins or + sample points or the kernel density estimate or any + combination of them? + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + jitter + Sets the amount of jitter in the sample points drawn. + If 0, the sample points align along the distribution + axis. If 1, the sample points are drawn in a random + jitter of width equal to the width of the violins. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.violin.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + line + :class:`plotly.graph_objects.violin.Line` instance or + dict with compatible properties + marker + :class:`plotly.graph_objects.violin.Marker` instance or + dict with compatible properties + meanline + :class:`plotly.graph_objects.violin.Meanline` instance + or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. For violin traces, the name + will also be used for the position coordinate, if `x` + and `x0` (`y` and `y0` if horizontal) are missing and + the position axis is categorical. Note that the trace + name is also used as a default value for attribute + `scalegroup` (please see its description for details). + 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. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the violin(s). If "v" ("h"), + the distribution is visualized along the vertical + (horizontal). + pointpos + Sets the position of the sample points in relation to + the violins. If 0, the sample points are places over + the center of the violins. Positive (negative) values + correspond to positions to the right (left) for + vertical violins and above (below) for horizontal + violins. + points + If "outliers", only the sample points lying outside the + whiskers are shown If "suspectedoutliers", the outlier + points are shown and points either less than 4*Q1-3*Q3 + or greater than 4*Q3-3*Q1 are highlighted (see + `outliercolor`) If "all", all sample points are shown + If False, only the violins are shown with no sample + points. Defaults to "suspectedoutliers" when + `marker.outliercolor` or `marker.line.outliercolor` is + set, otherwise defaults to "outliers". + quartilemethod + Sets the method used to compute the sample's Q1 and Q3 + quartiles. The "linear" method uses the 25th percentile + for Q1 and 75th percentile for Q3 as computed using + method #10 (listed on + http://jse.amstat.org/v14n3/langford.html). The + "exclusive" method uses the median to divide the + ordered dataset into two halves if the sample is odd, + it does not include the median in either half - Q1 is + then the median of the lower half and Q3 the median of + the upper half. The "inclusive" method also uses the + median to divide the ordered dataset into two halves + but if the sample is odd, it includes the median in + both halves - Q1 is then the median of the lower half + and Q3 the median of the upper half. + scalegroup + If there are multiple violins that should be sized + according to to some metric (see `scalemode`), link + them by providing a non-empty group id here shared by + every trace in the same group. If a violin's `width` is + undefined, `scalegroup` will default to the trace's + name. In this case, violins with the same names will be + linked together + scalemode + Sets the metric by which the width of each violin is + determined. "width" means each violin has the same + (max) width "count" means the violins are scaled by the + number of sample points making up each violin. + selected + :class:`plotly.graph_objects.violin.Selected` instance + or dict with compatible properties + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + side + Determines on which side of the position value the + density function making up one half of a violin is + plotted. Useful when comparing two violin traces under + "overlay" mode, where one trace has `side` set to + "positive" and the other to "negative". + span + Sets the span in data space for which the density + function will be computed. Has an effect only when + `spanmode` is set to "manual". + spanmode + Sets the method by which the span in data space where + the density function will be computed. "soft" means the + span goes from the sample's minimum value minus two + bandwidths to the sample's maximum value plus two + bandwidths. "hard" means the span goes from the + sample's minimum to its maximum value. For custom span + settings, use mode "manual" and fill in the `span` + attribute. + stream + :class:`plotly.graph_objects.violin.Stream` instance or + dict with compatible properties + text + Sets the text elements associated with each sample + value. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + unselected + :class:`plotly.graph_objects.violin.Unselected` + instance or dict with compatible properties + 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). + width + Sets the width of the violin in data coordinates. If 0 + (default value) the width is automatically selected + based on the positions of other violin traces in the + same subplot. + x + Sets the x sample data or coordinates. See overview for + more info. + x0 + Sets the x coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y sample data or coordinates. See overview for + more info. + y0 + Sets the y coordinate for single-box traces or the + starting coordinate for multi-box traces set using + q1/median/q3. See overview for more info. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Violin + """ + super().__init__("violin") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Violin +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Violin`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("bandwidth", arg, bandwidth) + self._set_property("box", arg, box) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hoveron", arg, hoveron) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("jitter", arg, jitter) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("marker", arg, marker) + self._set_property("meanline", arg, meanline) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("pointpos", arg, pointpos) + self._set_property("points", arg, points) + self._set_property("quartilemethod", arg, quartilemethod) + self._set_property("scalegroup", arg, scalegroup) + self._set_property("scalemode", arg, scalemode) + self._set_property("selected", arg, selected) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("side", arg, side) + self._set_property("span", arg, span) + self._set_property("spanmode", arg, spanmode) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("unselected", arg, unselected) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "violin" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_volume.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_volume.py new file mode 100644 index 0000000..9bc3099 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_volume.py @@ -0,0 +1,2211 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Volume(_BaseTraceType): + _parent_path_str = "" + _path_str = "volume" + _valid_props = { + "autocolorscale", + "caps", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colorscale", + "contour", + "customdata", + "customdatasrc", + "flatshading", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "isomax", + "isomin", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "lighting", + "lightposition", + "meta", + "metasrc", + "name", + "opacity", + "opacityscale", + "reversescale", + "scene", + "showlegend", + "showscale", + "slices", + "spaceframe", + "stream", + "surface", + "text", + "textsrc", + "type", + "uid", + "uirevision", + "value", + "valuehoverformat", + "valuesrc", + "visible", + "x", + "xhoverformat", + "xsrc", + "y", + "yhoverformat", + "ysrc", + "z", + "zhoverformat", + "zsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def caps(self): + """ + The 'caps' property is an instance of Caps + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Caps` + - A dict of string/value properties that will be passed + to the Caps constructor + + Returns + ------- + plotly.graph_objs.volume.Caps + """ + return self["caps"] + + @caps.setter + def caps(self, val): + self["caps"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here `value`) or the bounds set in + `cmin` and `cmax` Defaults to `false` when `cmin` and `cmax` + are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as `value` and if set, `cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as `value`. Has no effect when `cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as `value` and if set, `cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.volume.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def contour(self): + """ + The 'contour' property is an instance of Contour + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Contour` + - A dict of string/value properties that will be passed + to the Contour constructor + + Returns + ------- + plotly.graph_objs.volume.Contour + """ + return self["contour"] + + @contour.setter + def contour(self, val): + self["contour"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def flatshading(self): + """ + Determines whether or not normal smoothing is applied to the + meshes, creating meshes with an angular, low-poly look via flat + reflections. + + The 'flatshading' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["flatshading"] + + @flatshading.setter + def flatshading(self, val): + self["flatshading"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y', 'z', 'text', 'name'] joined with '+' characters + (e.g. 'x+y') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.volume.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Same as `text`. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def isomax(self): + """ + Sets the maximum boundary for iso-surface plot. + + The 'isomax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["isomax"] + + @isomax.setter + def isomax(self, val): + self["isomax"] = val + + @property + def isomin(self): + """ + Sets the minimum boundary for iso-surface plot. + + The 'isomin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["isomin"] + + @isomin.setter + def isomin(self, val): + self["isomin"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.volume.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def lighting(self): + """ + The 'lighting' property is an instance of Lighting + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Lighting` + - A dict of string/value properties that will be passed + to the Lighting constructor + + Returns + ------- + plotly.graph_objs.volume.Lighting + """ + return self["lighting"] + + @lighting.setter + def lighting(self, val): + self["lighting"] = val + + @property + def lightposition(self): + """ + The 'lightposition' property is an instance of Lightposition + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Lightposition` + - A dict of string/value properties that will be passed + to the Lightposition constructor + + Returns + ------- + plotly.graph_objs.volume.Lightposition + """ + return self["lightposition"] + + @lightposition.setter + def lightposition(self, val): + self["lightposition"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the surface. Please note that in the case + of using high `opacity` values for example a value greater than + or equal to 0.5 on two surfaces (and 0.25 with four surfaces), + an overlay of multiple transparent surfaces may not perfectly + be sorted in depth by the webgl API. This behavior may be + improved in the near future and is subject to change. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacityscale(self): + """ + Sets the opacityscale. The opacityscale must be an array + containing arrays mapping a normalized value to an opacity + value. At minimum, a mapping for the lowest (0) and highest (1) + values are required. For example, `[[0, 1], [0.5, 0.2], [1, + 1]]` means that higher/lower values would have higher opacity + values and those in the middle would be more transparent + Alternatively, `opacityscale` may be a palette name string of + the following list: 'min', 'max', 'extremes' and 'uniform'. The + default is 'uniform'. + + The 'opacityscale' property accepts values of any type + + Returns + ------- + Any + """ + return self["opacityscale"] + + @opacityscale.setter + def opacityscale(self, val): + self["opacityscale"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def scene(self): + """ + Sets a reference between this trace's 3D coordinate system and + a 3D scene. If "scene" (the default value), the (x,y,z) + coordinates refer to `layout.scene`. If "scene2", the (x,y,z) + coordinates refer to `layout.scene2`, and so on. + + The 'scene' property is an identifier of a particular + subplot, of type 'scene', that may be specified as the string 'scene' + optionally followed by an integer >= 1 + (e.g. 'scene', 'scene1', 'scene2', 'scene3', etc.) + + Returns + ------- + str + """ + return self["scene"] + + @scene.setter + def scene(self, val): + self["scene"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def slices(self): + """ + The 'slices' property is an instance of Slices + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Slices` + - A dict of string/value properties that will be passed + to the Slices constructor + + Returns + ------- + plotly.graph_objs.volume.Slices + """ + return self["slices"] + + @slices.setter + def slices(self, val): + self["slices"] = val + + @property + def spaceframe(self): + """ + The 'spaceframe' property is an instance of Spaceframe + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Spaceframe` + - A dict of string/value properties that will be passed + to the Spaceframe constructor + + Returns + ------- + plotly.graph_objs.volume.Spaceframe + """ + return self["spaceframe"] + + @spaceframe.setter + def spaceframe(self, val): + self["spaceframe"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.volume.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def surface(self): + """ + The 'surface' property is an instance of Surface + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.Surface` + - A dict of string/value properties that will be passed + to the Surface constructor + + Returns + ------- + plotly.graph_objs.volume.Surface + """ + return self["surface"] + + @surface.setter + def surface(self, val): + self["surface"] = val + + @property + def text(self): + """ + Sets the text elements associated with the vertices. If trace + `hoverinfo` contains a "text" flag and "hovertext" is not set, + these elements will be seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def value(self): + """ + Sets the 4th dimension (value) of the vertices. + + The 'value' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valuehoverformat(self): + """ + Sets the hover text formatting rulefor `value` using d3 + formatting mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format.By + default the values are formatted using generic number format. + + The 'valuehoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["valuehoverformat"] + + @valuehoverformat.setter + def valuehoverformat(self, val): + self["valuehoverformat"] = val + + @property + def valuesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `value`. + + The 'valuesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuesrc"] + + @valuesrc.setter + def valuesrc(self, val): + self["valuesrc"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the X coordinates of the vertices on X axis. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the Y coordinates of the vertices on Y axis. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the Z coordinates of the vertices on Z axis. + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zhoverformat(self): + """ + Sets the hover text formatting rulefor `z` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `zaxis.hoverformat`. + + The 'zhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["zhoverformat"] + + @zhoverformat.setter + def zhoverformat(self, val): + self["zhoverformat"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.volume.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties + spaceframe + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties + surface + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + caps=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colorscale=None, + contour=None, + customdata=None, + customdatasrc=None, + flatshading=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + isomax=None, + isomin=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + lighting=None, + lightposition=None, + meta=None, + metasrc=None, + name=None, + opacity=None, + opacityscale=None, + reversescale=None, + scene=None, + showlegend=None, + showscale=None, + slices=None, + spaceframe=None, + stream=None, + surface=None, + text=None, + textsrc=None, + uid=None, + uirevision=None, + value=None, + valuehoverformat=None, + valuesrc=None, + visible=None, + x=None, + xhoverformat=None, + xsrc=None, + y=None, + yhoverformat=None, + ysrc=None, + z=None, + zhoverformat=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Volume object + + Draws volume trace between iso-min and iso-max values with + coordinates given by four 1-dimensional arrays containing the + `value`, `x`, `y` and `z` of every vertex of a uniform or non- + uniform 3-D grid. Horizontal or vertical slices, caps as well + as spaceframe between iso-min and iso-max values could also be + drawn using this trace. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Volume` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + caps + :class:`plotly.graph_objects.volume.Caps` instance or + dict with compatible properties + cauto + Determines whether or not the color domain is computed + with respect to the input data (here `value`) or the + bounds set in `cmin` and `cmax` Defaults to `false` + when `cmin` and `cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as `value` and if set, `cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as `value`. Has no + effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as `value` and if set, `cmax` must + be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.volume.ColorBar` instance + or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + contour + :class:`plotly.graph_objects.volume.Contour` instance + or dict with compatible properties + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + flatshading + Determines whether or not normal smoothing is applied + to the meshes, creating meshes with an angular, low- + poly look via flat reflections. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.volume.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Same as `text`. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + isomax + Sets the maximum boundary for iso-surface plot. + isomin + Sets the minimum boundary for iso-surface plot. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.volume.Legendgrouptitle` + instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + lighting + :class:`plotly.graph_objects.volume.Lighting` instance + or dict with compatible properties + lightposition + :class:`plotly.graph_objects.volume.Lightposition` + instance or dict with compatible properties + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + opacity + Sets the opacity of the surface. Please note that in + the case of using high `opacity` values for example a + value greater than or equal to 0.5 on two surfaces (and + 0.25 with four surfaces), an overlay of multiple + transparent surfaces may not perfectly be sorted in + depth by the webgl API. This behavior may be improved + in the near future and is subject to change. + opacityscale + Sets the opacityscale. The opacityscale must be an + array containing arrays mapping a normalized value to + an opacity value. At minimum, a mapping for the lowest + (0) and highest (1) values are required. For example, + `[[0, 1], [0.5, 0.2], [1, 1]]` means that higher/lower + values would have higher opacity values and those in + the middle would be more transparent Alternatively, + `opacityscale` may be a palette name string of the + following list: 'min', 'max', 'extremes' and 'uniform'. + The default is 'uniform'. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + scene + Sets a reference between this trace's 3D coordinate + system and a 3D scene. If "scene" (the default value), + the (x,y,z) coordinates refer to `layout.scene`. If + "scene2", the (x,y,z) coordinates refer to + `layout.scene2`, and so on. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + showscale + Determines whether or not a colorbar is displayed for + this trace. + slices + :class:`plotly.graph_objects.volume.Slices` instance or + dict with compatible properties + spaceframe + :class:`plotly.graph_objects.volume.Spaceframe` + instance or dict with compatible properties + stream + :class:`plotly.graph_objects.volume.Stream` instance or + dict with compatible properties + surface + :class:`plotly.graph_objects.volume.Surface` instance + or dict with compatible properties + text + Sets the text elements associated with the vertices. If + trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + value + Sets the 4th dimension (value) of the vertices. + valuehoverformat + Sets the hover text formatting rulefor `value` using + d3 formatting mini-languages which are very similar to + those in Python. For numbers, see: https://github.com/d + 3/d3-format/tree/v1.4.5#d3-format.By default the values + are formatted using generic number format. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + 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). + x + Sets the X coordinates of the vertices on X axis. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the Y coordinates of the vertices on Y axis. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the Z coordinates of the vertices on Z axis. + zhoverformat + Sets the hover text formatting rulefor `z` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `zaxis.hoverformat`. + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Volume + """ + super().__init__("volume") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Volume +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Volume`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("caps", arg, caps) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("contour", arg, contour) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("flatshading", arg, flatshading) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("isomax", arg, isomax) + self._set_property("isomin", arg, isomin) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("lighting", arg, lighting) + self._set_property("lightposition", arg, lightposition) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("opacityscale", arg, opacityscale) + self._set_property("reversescale", arg, reversescale) + self._set_property("scene", arg, scene) + self._set_property("showlegend", arg, showlegend) + self._set_property("showscale", arg, showscale) + self._set_property("slices", arg, slices) + self._set_property("spaceframe", arg, spaceframe) + self._set_property("stream", arg, stream) + self._set_property("surface", arg, surface) + self._set_property("text", arg, text) + self._set_property("textsrc", arg, textsrc) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("value", arg, value) + self._set_property("valuehoverformat", arg, valuehoverformat) + self._set_property("valuesrc", arg, valuesrc) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zhoverformat", arg, zhoverformat) + self._set_property("zsrc", arg, zsrc) + + self._props["type"] = "volume" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/_waterfall.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/_waterfall.py new file mode 100644 index 0000000..04dc774 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/_waterfall.py @@ -0,0 +1,2580 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceType as _BaseTraceType +import copy as _copy + + +class Waterfall(_BaseTraceType): + _parent_path_str = "" + _path_str = "waterfall" + _valid_props = { + "alignmentgroup", + "base", + "cliponaxis", + "connector", + "constraintext", + "customdata", + "customdatasrc", + "decreasing", + "dx", + "dy", + "hoverinfo", + "hoverinfosrc", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "hovertext", + "hovertextsrc", + "ids", + "idssrc", + "increasing", + "insidetextanchor", + "insidetextfont", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "measure", + "measuresrc", + "meta", + "metasrc", + "name", + "offset", + "offsetgroup", + "offsetsrc", + "opacity", + "orientation", + "outsidetextfont", + "selectedpoints", + "showlegend", + "stream", + "text", + "textangle", + "textfont", + "textinfo", + "textposition", + "textpositionsrc", + "textsrc", + "texttemplate", + "texttemplatesrc", + "totals", + "type", + "uid", + "uirevision", + "visible", + "width", + "widthsrc", + "x", + "x0", + "xaxis", + "xhoverformat", + "xperiod", + "xperiod0", + "xperiodalignment", + "xsrc", + "y", + "y0", + "yaxis", + "yhoverformat", + "yperiod", + "yperiod0", + "yperiodalignment", + "ysrc", + "zorder", + } + + @property + def alignmentgroup(self): + """ + 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. + + The 'alignmentgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["alignmentgroup"] + + @alignmentgroup.setter + def alignmentgroup(self, val): + self["alignmentgroup"] = val + + @property + def base(self): + """ + Sets where the bar base is drawn (in position axis units). + + The 'base' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["base"] + + @base.setter + def base(self, val): + self["base"] = val + + @property + def cliponaxis(self): + """ + Determines whether the text nodes are clipped about the subplot + axes. To show the text nodes above axis lines and tick labels, + make sure to set `xaxis.layer` and `yaxis.layer` to *below + traces*. + + The 'cliponaxis' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cliponaxis"] + + @cliponaxis.setter + def cliponaxis(self, val): + self["cliponaxis"] = val + + @property + def connector(self): + """ + The 'connector' property is an instance of Connector + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Connector` + - A dict of string/value properties that will be passed + to the Connector constructor + + Returns + ------- + plotly.graph_objs.waterfall.Connector + """ + return self["connector"] + + @connector.setter + def connector(self, val): + self["connector"] = val + + @property + def constraintext(self): + """ + Constrain the size of text inside or outside a bar to be no + larger than the bar itself. + + The 'constraintext' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'both', 'none'] + + Returns + ------- + Any + """ + return self["constraintext"] + + @constraintext.setter + def constraintext(self, val): + self["constraintext"] = val + + @property + def customdata(self): + """ + 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 + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def decreasing(self): + """ + The 'decreasing' property is an instance of Decreasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Decreasing` + - A dict of string/value properties that will be passed + to the Decreasing constructor + + Returns + ------- + plotly.graph_objs.waterfall.Decreasing + """ + return self["decreasing"] + + @decreasing.setter + def decreasing(self, val): + self["decreasing"] = val + + @property + def dx(self): + """ + Sets the x coordinate step. See `x0` for more info. + + The 'dx' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dx"] + + @dx.setter + def dx(self, val): + self["dx"] = val + + @property + def dy(self): + """ + Sets the y coordinate step. See `y0` for more info. + + The 'dy' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dy"] + + @dy.setter + def dy(self, val): + self["dy"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear on hover. If `none` + or `skip` are set, no information is displayed upon hovering. + But, if `none` is set, click and hover events are still fired. + + The 'hoverinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['name', 'x', 'y', 'text', 'initial', 'delta', 'final'] joined with '+' characters + (e.g. 'name+x') + OR exactly one of ['all', 'none', 'skip'] (e.g. 'skip') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverinfosrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + + The 'hoverinfosrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hoverinfosrc"] + + @hoverinfosrc.setter + def hoverinfosrc(self, val): + self["hoverinfosrc"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.waterfall.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Finally, the + template string has access to variables `initial`, `delta` and + `final`. Anything contained in tag `` is displayed in + the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def hovertext(self): + """ + Sets hover text elements associated with each (x,y) pair. If a + single string, the same string appears over all the data + points. If an array of string, the items are mapped in order to + the this trace's (x,y) coordinates. To be seen, trace + `hoverinfo` must contain a "text" flag. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def hovertextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertext`. + + The 'hovertextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertextsrc"] + + @hovertextsrc.setter + def hovertextsrc(self, val): + self["hovertextsrc"] = val + + @property + def ids(self): + """ + 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. + + The 'ids' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ids"] + + @ids.setter + def ids(self, val): + self["ids"] = val + + @property + def idssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ids`. + + The 'idssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["idssrc"] + + @idssrc.setter + def idssrc(self, val): + self["idssrc"] = val + + @property + def increasing(self): + """ + The 'increasing' property is an instance of Increasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Increasing` + - A dict of string/value properties that will be passed + to the Increasing constructor + + Returns + ------- + plotly.graph_objs.waterfall.Increasing + """ + return self["increasing"] + + @increasing.setter + def increasing(self, val): + self["increasing"] = val + + @property + def insidetextanchor(self): + """ + Determines if texts are kept at center or start/end points in + `textposition` "inside" mode. + + The 'insidetextanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['end', 'middle', 'start'] + + Returns + ------- + Any + """ + return self["insidetextanchor"] + + @insidetextanchor.setter + def insidetextanchor(self, val): + self["insidetextanchor"] = val + + @property + def insidetextfont(self): + """ + Sets the font used for `text` lying inside the bar. + + The 'insidetextfont' property is an instance of Insidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Insidetextfont` + - A dict of string/value properties that will be passed + to the Insidetextfont constructor + + Returns + ------- + plotly.graph_objs.waterfall.Insidetextfont + """ + return self["insidetextfont"] + + @insidetextfont.setter + def insidetextfont(self, val): + self["insidetextfont"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this trace. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.waterfall.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this trace. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + trace. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def measure(self): + """ + An array containing types of values. By default the values are + considered as 'relative'. However; it is possible to use + 'total' to compute the sums. Also 'absolute' could be applied + to reset the computed total or to declare an initial value + where needed. + + The 'measure' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["measure"] + + @measure.setter + def measure(self, val): + self["measure"] = val + + @property + def measuresrc(self): + """ + Sets the source reference on Chart Studio Cloud for `measure`. + + The 'measuresrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["measuresrc"] + + @measuresrc.setter + def measuresrc(self, val): + self["measuresrc"] = val + + @property + def meta(self): + """ + Assigns extra meta information associated with this trace that + can be used in various text attributes. Attributes such as + trace `name`, graph, axis and colorbar `title.text`, annotation + `text` `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` values in + an attribute in the same trace, simply use `%{meta[i]}` where + `i` is the index or key of the `meta` item in question. To + access trace `meta` in layout attributes, use + `%{data[n[.meta[i]}` where `i` is the index or key of the + `meta` and `n` is the trace index. + + The 'meta' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["meta"] + + @meta.setter + def meta(self, val): + self["meta"] = val + + @property + def metasrc(self): + """ + Sets the source reference on Chart Studio Cloud for `meta`. + + The 'metasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["metasrc"] + + @metasrc.setter + def metasrc(self, val): + self["metasrc"] = val + + @property + def name(self): + """ + Sets the trace name. The trace name appears as the legend item + and on hover. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def offset(self): + """ + Shifts the position where the bar is drawn (in position axis + units). In "group" barmode, traces that set "offset" will be + excluded and drawn in "overlay" mode instead. + + The 'offset' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def offsetgroup(self): + """ + 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. + + The 'offsetgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["offsetgroup"] + + @offsetgroup.setter + def offsetgroup(self, val): + self["offsetgroup"] = val + + @property + def offsetsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `offset`. + + The 'offsetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["offsetsrc"] + + @offsetsrc.setter + def offsetsrc(self, val): + self["offsetsrc"] = val + + @property + def opacity(self): + """ + Sets the opacity of the trace. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def orientation(self): + """ + Sets the orientation of the bars. With "v" ("h"), the value of + the each bar spans along the vertical (horizontal). + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outsidetextfont(self): + """ + Sets the font used for `text` lying outside the bar. + + The 'outsidetextfont' property is an instance of Outsidetextfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont` + - A dict of string/value properties that will be passed + to the Outsidetextfont constructor + + Returns + ------- + plotly.graph_objs.waterfall.Outsidetextfont + """ + return self["outsidetextfont"] + + @outsidetextfont.setter + def outsidetextfont(self, val): + self["outsidetextfont"] = val + + @property + def selectedpoints(self): + """ + 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 `unselected` are + turned on for all points, whereas, any other non-array values + means no selection all where the `selected` and `unselected` + styles have no effect. + + The 'selectedpoints' property accepts values of any type + + Returns + ------- + Any + """ + return self["selectedpoints"] + + @selectedpoints.setter + def selectedpoints(self, val): + self["selectedpoints"] = val + + @property + def showlegend(self): + """ + Determines whether or not an item corresponding to this trace + is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def stream(self): + """ + The 'stream' property is an instance of Stream + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Stream` + - A dict of string/value properties that will be passed + to the Stream constructor + + Returns + ------- + plotly.graph_objs.waterfall.Stream + """ + return self["stream"] + + @stream.setter + def stream(self, val): + self["stream"] = val + + @property + def text(self): + """ + Sets text elements associated with each (x,y) pair. If a single + string, the same string appears over all the data points. If an + array of string, the items are mapped in order to the this + trace's (x,y) coordinates. If trace `hoverinfo` contains a + "text" flag and "hovertext" is not set, these elements will be + seen in the hover labels. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle of the tick labels with respect to the bar. For + example, a `tickangle` of -90 draws the tick labels vertically. + With "auto" the texts may automatically be rotated to fit with + the maximum size in bars. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def textfont(self): + """ + Sets the font used for `text`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.waterfall.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textinfo(self): + """ + Determines which trace information appear on the graph. In the + case of having multiple waterfalls, totals are computed + separately (per trace). + + The 'textinfo' property is a flaglist and may be specified + as a string containing: + - Any combination of ['label', 'text', 'initial', 'delta', 'final'] joined with '+' characters + (e.g. 'label+text') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["textinfo"] + + @textinfo.setter + def textinfo(self, val): + self["textinfo"] = val + + @property + def textposition(self): + """ + Specifies the location of the `text`. "inside" positions `text` + inside, next to the bar end (rotated and scaled if needed). + "outside" positions `text` outside, next to the bar end (scaled + if needed), unless there is another bar stacked on this one, + then the text gets pushed inside. "auto" tries to position + `text` inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If "none", no + text appears. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['inside', 'outside', 'auto', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def textpositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `textposition`. + + The 'textpositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textpositionsrc"] + + @textpositionsrc.setter + def textpositionsrc(self, val): + self["textpositionsrc"] = val + + @property + def textsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `text`. + + The 'textsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textsrc"] + + @textsrc.setter + def textsrc(self, val): + self["textsrc"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the information text that + appear on points. Note that this will override `textinfo`. + 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. Every attributes that can be specified per- + point (the ones that are `arrayOk: true`) are available. + Finally, the template string has access to variables `initial`, + `delta`, `final` and `label`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def texttemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + + The 'texttemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["texttemplatesrc"] + + @texttemplatesrc.setter + def texttemplatesrc(self, val): + self["texttemplatesrc"] = val + + @property + def totals(self): + """ + The 'totals' property is an instance of Totals + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.Totals` + - A dict of string/value properties that will be passed + to the Totals constructor + + Returns + ------- + plotly.graph_objs.waterfall.Totals + """ + return self["totals"] + + @totals.setter + def totals(self, val): + self["totals"] = val + + @property + def uid(self): + """ + Assign an id to this trace, Use this to provide object + constancy between traces during animations and transitions. + + The 'uid' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["uid"] + + @uid.setter + def uid(self, val): + self["uid"] = val + + @property + def uirevision(self): + """ + Controls persistence of some user-driven changes to the trace: + `constraintrange` in `parcoords` traces, as well as some + `editable: true` modifications such as `name` and + `colorbar.title`. Defaults to `layout.uirevision`. Note that + other user-driven trace attribute changes are controlled by + `layout` attributes: `trace.visible` is controlled by + `layout.legend.uirevision`, `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` (accessible + with `config: {editable: true}`) is controlled by + `layout.editrevision`. Trace changes are tracked by `uid`, + which only falls back on trace index if no `uid` is provided. + So if your app can add/remove traces before the end of the + `data` array, such that the same trace has a different index, + you can still preserve user-driven changes if you give each + trace a `uid` that stays with it as it moves. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + 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). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the bar width (in position axis units). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def x(self): + """ + Sets the x coordinates. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def x0(self): + """ + Alternate to `x`. Builds a linear space of x coordinates. Use + with `dx` where `x0` is the starting coordinate and `dx` the + step. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def xaxis(self): + """ + 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 `layout.xaxis`. If "x2", the x coordinates refer to + `layout.xaxis2`, and so on. + + The 'xaxis' property is an identifier of a particular + subplot, of type 'x', that may be specified as the string 'x' + optionally followed by an integer >= 1 + (e.g. 'x', 'x1', 'x2', 'x3', etc.) + + Returns + ------- + str + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def xhoverformat(self): + """ + Sets the hover text formatting rulefor `x` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `xaxis.hoverformat`. + + The 'xhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["xhoverformat"] + + @xhoverformat.setter + def xhoverformat(self, val): + self["xhoverformat"] = val + + @property + def xperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the x axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'xperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod"] + + @xperiod.setter + def xperiod(self, val): + self["xperiod"] = val + + @property + def xperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the x0 + axis. When `x0period` is round number of weeks, the `x0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'xperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["xperiod0"] + + @xperiod0.setter + def xperiod0(self, val): + self["xperiod0"] = val + + @property + def xperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + + The 'xperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["xperiodalignment"] + + @xperiodalignment.setter + def xperiodalignment(self, val): + self["xperiodalignment"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y coordinates. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def y0(self): + """ + Alternate to `y`. Builds a linear space of y coordinates. Use + with `dy` where `y0` is the starting coordinate and `dy` the + step. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def yaxis(self): + """ + 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 `layout.yaxis`. If "y2", the y coordinates refer to + `layout.yaxis2`, and so on. + + The 'yaxis' property is an identifier of a particular + subplot, of type 'y', that may be specified as the string 'y' + optionally followed by an integer >= 1 + (e.g. 'y', 'y1', 'y2', 'y3', etc.) + + Returns + ------- + str + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def yhoverformat(self): + """ + Sets the hover text formatting rulefor `y` using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display *09~15~23.46*By default the values + are formatted using `yaxis.hoverformat`. + + The 'yhoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["yhoverformat"] + + @yhoverformat.setter + def yhoverformat(self, val): + self["yhoverformat"] = val + + @property + def yperiod(self): + """ + Only relevant when the axis `type` is "date". Sets the period + positioning in milliseconds or "M" on the y axis. Special + values in the form of "M" could be used to declare the + number of months. In this case `n` must be a positive integer. + + The 'yperiod' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod"] + + @yperiod.setter + def yperiod(self, val): + self["yperiod"] = val + + @property + def yperiod0(self): + """ + Only relevant when the axis `type` is "date". Sets the base for + period positioning in milliseconds or date string on the y0 + axis. When `y0period` is round number of weeks, the `y0period0` + by default would be on a Sunday i.e. 2000-01-02, otherwise it + would be at 2000-01-01. + + The 'yperiod0' property accepts values of any type + + Returns + ------- + Any + """ + return self["yperiod0"] + + @yperiod0.setter + def yperiod0(self, val): + self["yperiod0"] = val + + @property + def yperiodalignment(self): + """ + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + + The 'yperiodalignment' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["yperiodalignment"] + + @yperiodalignment.setter + def yperiodalignment(self, val): + self["yperiodalignment"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def zorder(self): + """ + Sets the layer on which this trace is displayed, relative to + other SVG traces on the same subplot. SVG traces with higher + `zorder` appear in front of those with lower `zorder`. + + The 'zorder' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["zorder"] + + @zorder.setter + def zorder(self, val): + self["zorder"] = val + + @property + def type(self): + return self._props["type"] + + @property + def _prop_descriptions(self): + return """\ + 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. + base + Sets where the bar base is drawn (in position axis + units). + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta` and `final`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.waterfall.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + measure + An array containing types of values. By default the + values are considered as 'relative'. However; it is + possible to use 'total' to compute the sums. Also + 'absolute' could be applied to reset the computed total + or to declare an initial value where needed. + measuresrc + Sets the source reference on Chart Studio Cloud for + `measure`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple waterfalls, totals are + computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta`, `final` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + totals + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + """ + + def __init__( + self, + arg=None, + alignmentgroup=None, + base=None, + cliponaxis=None, + connector=None, + constraintext=None, + customdata=None, + customdatasrc=None, + decreasing=None, + dx=None, + dy=None, + hoverinfo=None, + hoverinfosrc=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + hovertext=None, + hovertextsrc=None, + ids=None, + idssrc=None, + increasing=None, + insidetextanchor=None, + insidetextfont=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + measure=None, + measuresrc=None, + meta=None, + metasrc=None, + name=None, + offset=None, + offsetgroup=None, + offsetsrc=None, + opacity=None, + orientation=None, + outsidetextfont=None, + selectedpoints=None, + showlegend=None, + stream=None, + text=None, + textangle=None, + textfont=None, + textinfo=None, + textposition=None, + textpositionsrc=None, + textsrc=None, + texttemplate=None, + texttemplatesrc=None, + totals=None, + uid=None, + uirevision=None, + visible=None, + width=None, + widthsrc=None, + x=None, + x0=None, + xaxis=None, + xhoverformat=None, + xperiod=None, + xperiod0=None, + xperiodalignment=None, + xsrc=None, + y=None, + y0=None, + yaxis=None, + yhoverformat=None, + yperiod=None, + yperiod0=None, + yperiodalignment=None, + ysrc=None, + zorder=None, + **kwargs, + ): + """ + Construct a new Waterfall object + + Draws waterfall trace which is useful graph to displays the + contribution of various elements (either positive or negative) + in a bar chart. The data visualized by the span of the bars is + set in `y` if `orientation` is set to "v" (the default) and the + labels are set in `x`. By setting `orientation` to "h", the + roles are interchanged. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.Waterfall` + 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. + base + Sets where the bar base is drawn (in position axis + units). + cliponaxis + Determines whether the text nodes are clipped about the + subplot axes. To show the text nodes above axis lines + and tick labels, make sure to set `xaxis.layer` and + `yaxis.layer` to *below traces*. + connector + :class:`plotly.graph_objects.waterfall.Connector` + instance or dict with compatible properties + constraintext + Constrain the size of text inside or outside a bar to + be no larger than the bar itself. + 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 + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + decreasing + :class:`plotly.graph_objects.waterfall.Decreasing` + instance or dict with compatible properties + dx + Sets the x coordinate step. See `x0` for more info. + dy + Sets the y coordinate step. See `y0` for more info. + hoverinfo + Determines which trace information appear on hover. If + `none` or `skip` are set, no information is displayed + upon hovering. But, if `none` is set, click and hover + events are still fired. + hoverinfosrc + Sets the source reference on Chart Studio Cloud for + `hoverinfo`. + hoverlabel + :class:`plotly.graph_objects.waterfall.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta` and `final`. Anything + contained in tag `` is displayed in the + secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + hovertext + Sets hover text elements associated with each (x,y) + pair. If a single string, the same string appears over + all the data points. If an array of string, the items + are mapped in order to the this trace's (x,y) + coordinates. To be seen, trace `hoverinfo` must contain + a "text" flag. + hovertextsrc + Sets the source reference on Chart Studio Cloud for + `hovertext`. + 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. + idssrc + Sets the source reference on Chart Studio Cloud for + `ids`. + increasing + :class:`plotly.graph_objects.waterfall.Increasing` + instance or dict with compatible properties + insidetextanchor + Determines if texts are kept at center or start/end + points in `textposition` "inside" mode. + insidetextfont + Sets the font used for `text` lying inside the bar. + legend + Sets the reference to a legend to show this trace in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this trace. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.waterfall.Legendgrouptitle + ` instance or dict with compatible properties + legendrank + Sets the legend rank for this trace. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this trace. + measure + An array containing types of values. By default the + values are considered as 'relative'. However; it is + possible to use 'total' to compute the sums. Also + 'absolute' could be applied to reset the computed total + or to declare an initial value where needed. + measuresrc + Sets the source reference on Chart Studio Cloud for + `measure`. + meta + Assigns extra meta information associated with this + trace that can be used in various text attributes. + Attributes such as trace `name`, graph, axis and + colorbar `title.text`, annotation `text` + `rangeselector`, `updatemenues` and `sliders` `label` + text all support `meta`. To access the trace `meta` + values in an attribute in the same trace, simply use + `%{meta[i]}` where `i` is the index or key of the + `meta` item in question. To access trace `meta` in + layout attributes, use `%{data[n[.meta[i]}` where `i` + is the index or key of the `meta` and `n` is the trace + index. + metasrc + Sets the source reference on Chart Studio Cloud for + `meta`. + name + Sets the trace name. The trace name appears as the + legend item and on hover. + offset + Shifts the position where the bar is drawn (in position + axis units). In "group" barmode, traces that set + "offset" will be excluded and drawn in "overlay" mode + instead. + 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. + offsetsrc + Sets the source reference on Chart Studio Cloud for + `offset`. + opacity + Sets the opacity of the trace. + orientation + Sets the orientation of the bars. With "v" ("h"), the + value of the each bar spans along the vertical + (horizontal). + outsidetextfont + Sets the font used for `text` lying outside the bar. + 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 `unselected` are turned on for all points, whereas, + any other non-array values means no selection all where + the `selected` and `unselected` styles have no effect. + showlegend + Determines whether or not an item corresponding to this + trace is shown in the legend. + stream + :class:`plotly.graph_objects.waterfall.Stream` instance + or dict with compatible properties + text + Sets text elements associated with each (x,y) pair. If + a single string, the same string appears over all the + data points. If an array of string, the items are + mapped in order to the this trace's (x,y) coordinates. + If trace `hoverinfo` contains a "text" flag and + "hovertext" is not set, these elements will be seen in + the hover labels. + textangle + Sets the angle of the tick labels with respect to the + bar. For example, a `tickangle` of -90 draws the tick + labels vertically. With "auto" the texts may + automatically be rotated to fit with the maximum size + in bars. + textfont + Sets the font used for `text`. + textinfo + Determines which trace information appear on the graph. + In the case of having multiple waterfalls, totals are + computed separately (per trace). + textposition + Specifies the location of the `text`. "inside" + positions `text` inside, next to the bar end (rotated + and scaled if needed). "outside" positions `text` + outside, next to the bar end (scaled if needed), unless + there is another bar stacked on this one, then the text + gets pushed inside. "auto" tries to position `text` + inside the bar, but if the bar is too small and no bar + is stacked on this one the text is moved outside. If + "none", no text appears. + textpositionsrc + Sets the source reference on Chart Studio Cloud for + `textposition`. + textsrc + Sets the source reference on Chart Studio Cloud for + `text`. + texttemplate + Template string used for rendering the information text + that appear on points. Note that this will override + `textinfo`. 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-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. Every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Finally, the template string has access + to variables `initial`, `delta`, `final` and `label`. + texttemplatesrc + Sets the source reference on Chart Studio Cloud for + `texttemplate`. + totals + :class:`plotly.graph_objects.waterfall.Totals` instance + or dict with compatible properties + uid + Assign an id to this trace, Use this to provide object + constancy between traces during animations and + transitions. + uirevision + Controls persistence of some user-driven changes to the + trace: `constraintrange` in `parcoords` traces, as well + as some `editable: true` modifications such as `name` + and `colorbar.title`. Defaults to `layout.uirevision`. + Note that other user-driven trace attribute changes are + controlled by `layout` attributes: `trace.visible` is + controlled by `layout.legend.uirevision`, + `selectedpoints` is controlled by + `layout.selectionrevision`, and `colorbar.(x|y)` + (accessible with `config: {editable: true}`) is + controlled by `layout.editrevision`. Trace changes are + tracked by `uid`, which only falls back on trace index + if no `uid` is provided. So if your app can add/remove + traces before the end of the `data` array, such that + the same trace has a different index, you can still + preserve user-driven changes if you give each trace a + `uid` that stays with it as it moves. + 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). + width + Sets the bar width (in position axis units). + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + x + Sets the x coordinates. + x0 + Alternate to `x`. Builds a linear space of x + coordinates. Use with `dx` where `x0` is the starting + coordinate and `dx` the step. + 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 `layout.xaxis`. If "x2", the x + coordinates refer to `layout.xaxis2`, and so on. + xhoverformat + Sets the hover text formatting rulefor `x` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `xaxis.hoverformat`. + xperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the x + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + xperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the x0 axis. When `x0period` is round number + of weeks, the `x0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + xperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the x axis. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y coordinates. + y0 + Alternate to `y`. Builds a linear space of y + coordinates. Use with `dy` where `y0` is the starting + coordinate and `dy` the step. + 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 `layout.yaxis`. If "y2", the y + coordinates refer to `layout.yaxis2`, and so on. + yhoverformat + Sets the hover text formatting rulefor `y` using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display *09~15~23.46*By default the values are + formatted using `yaxis.hoverformat`. + yperiod + Only relevant when the axis `type` is "date". Sets the + period positioning in milliseconds or "M" on the y + axis. Special values in the form of "M" could be + used to declare the number of months. In this case `n` + must be a positive integer. + yperiod0 + Only relevant when the axis `type` is "date". Sets the + base for period positioning in milliseconds or date + string on the y0 axis. When `y0period` is round number + of weeks, the `y0period0` by default would be on a + Sunday i.e. 2000-01-02, otherwise it would be at + 2000-01-01. + yperiodalignment + Only relevant when the axis `type` is "date". Sets the + alignment of data points on the y axis. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + zorder + Sets the layer on which this trace is displayed, + relative to other SVG traces on the same subplot. SVG + traces with higher `zorder` appear in front of those + with lower `zorder`. + + Returns + ------- + Waterfall + """ + super().__init__("waterfall") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.Waterfall +constructor must be a dict or +an instance of :class:`plotly.graph_objs.Waterfall`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("alignmentgroup", arg, alignmentgroup) + self._set_property("base", arg, base) + self._set_property("cliponaxis", arg, cliponaxis) + self._set_property("connector", arg, connector) + self._set_property("constraintext", arg, constraintext) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("decreasing", arg, decreasing) + self._set_property("dx", arg, dx) + self._set_property("dy", arg, dy) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverinfosrc", arg, hoverinfosrc) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("hovertext", arg, hovertext) + self._set_property("hovertextsrc", arg, hovertextsrc) + self._set_property("ids", arg, ids) + self._set_property("idssrc", arg, idssrc) + self._set_property("increasing", arg, increasing) + self._set_property("insidetextanchor", arg, insidetextanchor) + self._set_property("insidetextfont", arg, insidetextfont) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("measure", arg, measure) + self._set_property("measuresrc", arg, measuresrc) + self._set_property("meta", arg, meta) + self._set_property("metasrc", arg, metasrc) + self._set_property("name", arg, name) + self._set_property("offset", arg, offset) + self._set_property("offsetgroup", arg, offsetgroup) + self._set_property("offsetsrc", arg, offsetsrc) + self._set_property("opacity", arg, opacity) + self._set_property("orientation", arg, orientation) + self._set_property("outsidetextfont", arg, outsidetextfont) + self._set_property("selectedpoints", arg, selectedpoints) + self._set_property("showlegend", arg, showlegend) + self._set_property("stream", arg, stream) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("textfont", arg, textfont) + self._set_property("textinfo", arg, textinfo) + self._set_property("textposition", arg, textposition) + self._set_property("textpositionsrc", arg, textpositionsrc) + self._set_property("textsrc", arg, textsrc) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("texttemplatesrc", arg, texttemplatesrc) + self._set_property("totals", arg, totals) + self._set_property("uid", arg, uid) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._set_property("x", arg, x) + self._set_property("x0", arg, x0) + self._set_property("xaxis", arg, xaxis) + self._set_property("xhoverformat", arg, xhoverformat) + self._set_property("xperiod", arg, xperiod) + self._set_property("xperiod0", arg, xperiod0) + self._set_property("xperiodalignment", arg, xperiodalignment) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("y0", arg, y0) + self._set_property("yaxis", arg, yaxis) + self._set_property("yhoverformat", arg, yhoverformat) + self._set_property("yperiod", arg, yperiod) + self._set_property("yperiod0", arg, yperiod0) + self._set_property("yperiodalignment", arg, yperiodalignment) + self._set_property("ysrc", arg, ysrc) + self._set_property("zorder", arg, zorder) + + self._props["type"] = "waterfall" + arg.pop("type", None) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/__init__.py new file mode 100644 index 0000000..3b22b71 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/__init__.py @@ -0,0 +1,40 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._error_x import ErrorX + from ._error_y import ErrorY + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._error_x.ErrorX", + "._error_y.ErrorY", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_x.py new file mode 100644 index 0000000..f28208c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_x.py @@ -0,0 +1,502 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.error_x" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "copy_ystyle", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["copy_ystyle"] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self["copy_ystyle"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.ErrorX` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super().__init__("error_x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.ErrorX +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.ErrorX`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("copy_ystyle", arg, copy_ystyle) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_y.py new file mode 100644 index 0000000..e5db21f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_error_y.py @@ -0,0 +1,479 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.error_y" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.ErrorY` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super().__init__("error_y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.ErrorY +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.ErrorY`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_hoverlabel.py new file mode 100644 index 0000000..65ab966 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.bar.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_insidetextfont.py new file mode 100644 index 0000000..f1c48da --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `text` lying inside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_legendgrouptitle.py new file mode 100644 index 0000000..3a74894 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.bar.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_marker.py new file mode 100644 index 0000000..a80880e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_marker.py @@ -0,0 +1,685 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "cornerradius", + "line", + "opacity", + "opacitysrc", + "pattern", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to bar.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.bar.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def cornerradius(self): + """ + Sets the rounding of corners. May be an integer number of + pixels, or a percentage of bar width (as a string ending in %). + Defaults to `layout.barcornerradius`. In stack or relative + barmode, the first trace to set cornerradius is used for the + whole stack. + + The 'cornerradius' property accepts values of any type + + Returns + ------- + Any + """ + return self["cornerradius"] + + @cornerradius.setter + def cornerradius(self, val): + self["cornerradius"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.bar.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the bars. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.bar.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.bar.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + cornerradius + Sets the rounding of corners. May be an integer number + of pixels, or a percentage of bar width (as a string + ending in %). Defaults to `layout.barcornerradius`. In + stack or relative barmode, the first trace to set + cornerradius is used for the whole stack. + line + :class:`plotly.graph_objects.bar.marker.Line` instance + or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + cornerradius=None, + line=None, + opacity=None, + opacitysrc=None, + pattern=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.bar.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + cornerradius + Sets the rounding of corners. May be an integer number + of pixels, or a percentage of bar width (as a string + ending in %). Defaults to `layout.barcornerradius`. In + stack or relative barmode, the first trace to set + cornerradius is used for the whole stack. + line + :class:`plotly.graph_objects.bar.marker.Line` instance + or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("cornerradius", arg, cornerradius) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("pattern", arg, pattern) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_outsidetextfont.py new file mode 100644 index 0000000..2e2a8a3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_outsidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `text` lying outside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_selected.py new file mode 100644 index 0000000..df30936 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_selected.py @@ -0,0 +1,105 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.bar.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.bar.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.bar.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.bar.selected.Textfont` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.Selected` + marker + :class:`plotly.graph_objects.bar.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.bar.selected.Textfont` + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_stream.py new file mode 100644 index 0000000..c4d3c05 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_textfont.py new file mode 100644 index 0000000..f63c5c4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_textfont.py @@ -0,0 +1,586 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `text`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_unselected.py new file mode 100644 index 0000000..9bd645d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "bar" + _path_str = "bar.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.bar.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.bar.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.bar.unselected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.bar.unselected.Textfont` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.Unselected` + marker + :class:`plotly.graph_objects.bar.unselected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.bar.unselected.Textfont` + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/_font.py new file mode 100644 index 0000000..485d5a7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "bar.hoverlabel" + _path_str = "bar.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/_font.py new file mode 100644 index 0000000..9c134c3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "bar.legendgrouptitle" + _path_str = "bar.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/__init__.py new file mode 100644 index 0000000..e2d7a12 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from ._pattern import Pattern + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_colorbar.py new file mode 100644 index 0000000..529a714 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_colorbar.py @@ -0,0 +1,1721 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker" + _path_str = "bar.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.bar.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.bar.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.bar.marker.col + orbar.tickformatstopdefaults), sets the default property values + to use for elements of bar.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.bar.marker.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.bar.ma + rker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + bar.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.bar.marker.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.bar.marker.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.bar.ma + rker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + bar.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.bar.marker.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_line.py new file mode 100644 index 0000000..f9d515b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker" + _path_str = "bar.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to bar.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_pattern.py new file mode 100644 index 0000000..71b73ab --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker" + _path_str = "bar.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..5cfa677 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker.colorbar" + _path_str = "bar.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..04819a0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker.colorbar" + _path_str = "bar.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.marker.col + orbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_title.py new file mode 100644 index 0000000..ac2a569 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker.colorbar" + _path_str = "bar.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.bar.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/_font.py new file mode 100644 index 0000000..a3c50a3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "bar.marker.colorbar.title" + _path_str = "bar.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.bar.marker.col + orbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_marker.py new file mode 100644 index 0000000..e704eb4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_marker.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "bar.selected" + _path_str = "bar.selected.marker" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_textfont.py new file mode 100644 index 0000000..79fb7ab --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "bar.selected" + _path_str = "bar.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_marker.py new file mode 100644 index 0000000..a4e004c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_marker.py @@ -0,0 +1,110 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "bar.unselected" + _path_str = "bar.unselected.marker" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_textfont.py new file mode 100644 index 0000000..eb15311 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/bar/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "bar.unselected" + _path_str = "bar.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.bar.unselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.bar.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.bar.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/__init__.py new file mode 100644 index 0000000..12dab9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/__init__.py @@ -0,0 +1,30 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_hoverlabel.py new file mode 100644 index 0000000..bfb053f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "barpolar" + _path_str = "barpolar.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.barpolar.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_legendgrouptitle.py new file mode 100644 index 0000000..d5a6556 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "barpolar" + _path_str = "barpolar.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.barpolar.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_marker.py new file mode 100644 index 0000000..5015e40 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_marker.py @@ -0,0 +1,650 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "barpolar" + _path_str = "barpolar.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "line", + "opacity", + "opacitysrc", + "pattern", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to barpolar.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the bars. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.barpolar.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.barpolar.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + pattern=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.barpolar.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.barpolar.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("pattern", arg, pattern) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_selected.py new file mode 100644 index 0000000..60132e3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "barpolar" + _path_str = "barpolar.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.barpolar.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.barpolar.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.barpolar.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.barpolar.selected.Textfont + ` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.Selected` + marker + :class:`plotly.graph_objects.barpolar.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.barpolar.selected.Textfont + ` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_stream.py new file mode 100644 index 0000000..8640dbb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "barpolar" + _path_str = "barpolar.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_unselected.py new file mode 100644 index 0000000..ef4cde9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "barpolar" + _path_str = "barpolar.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.barpolar.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.barpolar.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.barpolar.unselected.Marker + ` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.barpolar.unselected.Textfo + nt` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.Unselected` + marker + :class:`plotly.graph_objects.barpolar.unselected.Marker + ` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.barpolar.unselected.Textfo + nt` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/_font.py new file mode 100644 index 0000000..fd59e9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.hoverlabel" + _path_str = "barpolar.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/_font.py new file mode 100644 index 0000000..5c097a1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.legendgrouptitle" + _path_str = "barpolar.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.barpolar.legen + dgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/__init__.py new file mode 100644 index 0000000..e2d7a12 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from ._pattern import Pattern + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_colorbar.py new file mode 100644 index 0000000..112445d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker" + _path_str = "barpolar.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.barpolar.marke + r.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + barpolar.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.barpolar.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.barpol + ar.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + barpolar.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.barpolar.marker.colorbar.T + itle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.barpolar.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.barpol + ar.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + barpolar.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.barpolar.marker.colorbar.T + itle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_line.py new file mode 100644 index 0000000..9449d22 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker" + _path_str = "barpolar.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to barpolar.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_pattern.py new file mode 100644 index 0000000..e94caf7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker" + _path_str = "barpolar.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..3f1bdc9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker.colorbar" + _path_str = "barpolar.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..c860e69 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker.colorbar" + _path_str = "barpolar.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_title.py new file mode 100644 index 0000000..6c674fb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker.colorbar" + _path_str = "barpolar.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.barpolar.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py new file mode 100644 index 0000000..fac5ba9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.marker.colorbar.title" + _path_str = "barpolar.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.barpolar.marke + r.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_marker.py new file mode 100644 index 0000000..ca4aba8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_marker.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.selected" + _path_str = "barpolar.selected.marker" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_textfont.py new file mode 100644 index 0000000..111a9ff --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.selected" + _path_str = "barpolar.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_marker.py new file mode 100644 index 0000000..85e314b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_marker.py @@ -0,0 +1,110 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.unselected" + _path_str = "barpolar.unselected.marker" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_textfont.py new file mode 100644 index 0000000..41ad2f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/barpolar/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "barpolar.unselected" + _path_str = "barpolar.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.barpolar.unselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.barpolar.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.barpolar.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/__init__.py new file mode 100644 index 0000000..f9bb46f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/__init__.py @@ -0,0 +1,32 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_hoverlabel.py new file mode 100644 index 0000000..b273e6c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.box.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_legendgrouptitle.py new file mode 100644 index 0000000..a2c2541 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.box.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_line.py new file mode 100644 index 0000000..4887c7e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_line.py @@ -0,0 +1,103 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of line bounding the box(es). + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of line bounding the box(es). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.box.Line` + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_marker.py new file mode 100644 index 0000000..eaf4f80 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_marker.py @@ -0,0 +1,357 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.marker" + _valid_props = { + "angle", + "color", + "line", + "opacity", + "outliercolor", + "size", + "symbol", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.box.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def outliercolor(self): + """ + Sets the color of the outlier sample points. + + The 'outliercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outliercolor"] + + @outliercolor.setter + def outliercolor(self, val): + self["outliercolor"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + + Returns + ------- + Any + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + :class:`plotly.graph_objects.box.marker.Line` instance + or dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + """ + + def __init__( + self, + arg=None, + angle=None, + color=None, + line=None, + opacity=None, + outliercolor=None, + size=None, + symbol=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.box.Marker` + angle + Sets the marker angle in respect to `angleref`. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + :class:`plotly.graph_objects.box.marker.Line` instance + or dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("outliercolor", arg, outliercolor) + self._set_property("size", arg, size) + self._set_property("symbol", arg, symbol) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_selected.py new file mode 100644 index 0000000..cb94773 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_selected.py @@ -0,0 +1,79 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.box.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.box.selected.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.box.Selected` + marker + :class:`plotly.graph_objects.box.selected.Marker` + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_stream.py new file mode 100644 index 0000000..b6cd0eb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.box.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_unselected.py new file mode 100644 index 0000000..9db72eb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "box" + _path_str = "box.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.box.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.box.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.box.unselected.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.Unselected` + marker + :class:`plotly.graph_objects.box.unselected.Marker` + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/_font.py new file mode 100644 index 0000000..f4ab0af --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "box.hoverlabel" + _path_str = "box.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/_font.py new file mode 100644 index 0000000..aa42e3d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "box.legendgrouptitle" + _path_str = "box.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/_line.py new file mode 100644 index 0000000..95b6e0b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/marker/_line.py @@ -0,0 +1,181 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "box.marker" + _path_str = "box.marker.line" + _valid_props = {"color", "outliercolor", "outlierwidth", "width"} + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def outliercolor(self): + """ + Sets the border line color of the outlier sample points. + Defaults to marker.color + + The 'outliercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outliercolor"] + + @outliercolor.setter + def outliercolor(self, val): + self["outliercolor"] = val + + @property + def outlierwidth(self): + """ + Sets the border line width (in px) of the outlier sample + points. + + The 'outlierwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlierwidth"] + + @outlierwidth.setter + def outlierwidth(self, val): + self["outlierwidth"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + """ + + def __init__( + self, + arg=None, + color=None, + outliercolor=None, + outlierwidth=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.marker.Line` + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("outliercolor", arg, outliercolor) + self._set_property("outlierwidth", arg, outlierwidth) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/_marker.py new file mode 100644 index 0000000..b4f9afa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "box.selected" + _path_str = "box.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/_marker.py new file mode 100644 index 0000000..b2c5d8f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/box/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "box.unselected" + _path_str = "box.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.box.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.box.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.box.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/__init__.py new file mode 100644 index 0000000..464258c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/__init__.py @@ -0,0 +1,29 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._decreasing import Decreasing + from ._hoverlabel import Hoverlabel + from ._increasing import Increasing + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._stream import Stream + from . import decreasing + from . import hoverlabel + from . import increasing + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".decreasing", ".hoverlabel", ".increasing", ".legendgrouptitle"], + [ + "._decreasing.Decreasing", + "._hoverlabel.Hoverlabel", + "._increasing.Increasing", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_decreasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_decreasing.py new file mode 100644 index 0000000..c801692 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_decreasing.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Decreasing(_BaseTraceHierarchyType): + _parent_path_str = "candlestick" + _path_str = "candlestick.decreasing" + _valid_props = {"fillcolor", "line"} + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.decreasing.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.candlestick.decreasing.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + :class:`plotly.graph_objects.candlestick.decreasing.Lin + e` instance or dict with compatible properties + """ + + def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): + """ + Construct a new Decreasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.Decreasing` + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + :class:`plotly.graph_objects.candlestick.decreasing.Lin + e` instance or dict with compatible properties + + Returns + ------- + Decreasing + """ + super().__init__("decreasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.Decreasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.Decreasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fillcolor", arg, fillcolor) + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_hoverlabel.py new file mode 100644 index 0000000..b2c8c86 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_hoverlabel.py @@ -0,0 +1,366 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "candlestick" + _path_str = "candlestick.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + "split", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.candlestick.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def split(self): + """ + Show hover information (open, close, high, low) in separate + labels. + + The 'split' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["split"] + + @split.setter + def split(self, val): + self["split"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + split + Show hover information (open, close, high, low) in + separate labels. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + split=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + split + Show hover information (open, close, high, low) in + separate labels. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._set_property("split", arg, split) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_increasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_increasing.py new file mode 100644 index 0000000..547e846 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_increasing.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Increasing(_BaseTraceHierarchyType): + _parent_path_str = "candlestick" + _path_str = "candlestick.increasing" + _valid_props = {"fillcolor", "line"} + + @property + def fillcolor(self): + """ + Sets the fill color. Defaults to a half-transparent variant of + the line color, marker color, or marker line color, whichever + is available. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.increasing.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.candlestick.increasing.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + :class:`plotly.graph_objects.candlestick.increasing.Lin + e` instance or dict with compatible properties + """ + + def __init__(self, arg=None, fillcolor=None, line=None, **kwargs): + """ + Construct a new Increasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.Increasing` + fillcolor + Sets the fill color. Defaults to a half-transparent + variant of the line color, marker color, or marker line + color, whichever is available. + line + :class:`plotly.graph_objects.candlestick.increasing.Lin + e` instance or dict with compatible properties + + Returns + ------- + Increasing + """ + super().__init__("increasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.Increasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.Increasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fillcolor", arg, fillcolor) + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_legendgrouptitle.py new file mode 100644 index 0000000..c4fb3f7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "candlestick" + _path_str = "candlestick.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.candlestick.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.candlestick.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_line.py new file mode 100644 index 0000000..4250d33 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_line.py @@ -0,0 +1,85 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "candlestick" + _path_str = "candlestick.line" + _valid_props = {"width"} + + @property + def width(self): + """ + Sets the width (in px) of line bounding the box(es). Note that + this style setting can also be set per direction via + `increasing.line.width` and `decreasing.line.width`. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + width + Sets the width (in px) of line bounding the box(es). + Note that this style setting can also be set per + direction via `increasing.line.width` and + `decreasing.line.width`. + """ + + def __init__(self, arg=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.Line` + width + Sets the width (in px) of line bounding the box(es). + Note that this style setting can also be set per + direction via `increasing.line.width` and + `decreasing.line.width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_stream.py new file mode 100644 index 0000000..1242e42 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "candlestick" + _path_str = "candlestick.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/_line.py new file mode 100644 index 0000000..4e0f2e0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/decreasing/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "candlestick.decreasing" + _path_str = "candlestick.decreasing.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of line bounding the box(es). + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of line bounding the box(es). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.decreasing.Line` + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.decreasing.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.decreasing.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/_font.py new file mode 100644 index 0000000..86e1b5a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "candlestick.hoverlabel" + _path_str = "candlestick.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/_line.py new file mode 100644 index 0000000..964d07d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/increasing/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "candlestick.increasing" + _path_str = "candlestick.increasing.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of line bounding the box(es). + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of line bounding the box(es). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.candlestick.increasing.Line` + color + Sets the color of line bounding the box(es). + width + Sets the width (in px) of line bounding the box(es). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.increasing.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.increasing.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/_font.py new file mode 100644 index 0000000..3026f85 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/candlestick/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "candlestick.legendgrouptitle" + _path_str = "candlestick.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.candlestick.le + gendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.candlestick.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.candlestick.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/__init__.py new file mode 100644 index 0000000..38c554d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/__init__.py @@ -0,0 +1,26 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._aaxis import Aaxis + from ._baxis import Baxis + from ._font import Font + from ._legendgrouptitle import Legendgrouptitle + from ._stream import Stream + from . import aaxis + from . import baxis + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".aaxis", ".baxis", ".legendgrouptitle"], + [ + "._aaxis.Aaxis", + "._baxis.Baxis", + "._font.Font", + "._legendgrouptitle.Legendgrouptitle", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_aaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_aaxis.py new file mode 100644 index 0000000..f10597e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_aaxis.py @@ -0,0 +1,1850 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Aaxis(_BaseTraceHierarchyType): + _parent_path_str = "carpet" + _path_str = "carpet.aaxis" + _valid_props = { + "arraydtick", + "arraytick0", + "autorange", + "autotypenumbers", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "cheatertype", + "color", + "dtick", + "endline", + "endlinecolor", + "endlinewidth", + "exponentformat", + "fixedrange", + "gridcolor", + "griddash", + "gridwidth", + "labelalias", + "labelpadding", + "labelprefix", + "labelsuffix", + "linecolor", + "linewidth", + "minexponent", + "minorgridcolor", + "minorgridcount", + "minorgriddash", + "minorgridwidth", + "nticks", + "range", + "rangemode", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "smoothing", + "startline", + "startlinecolor", + "startlinewidth", + "tick0", + "tickangle", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "tickmode", + "tickprefix", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "title", + "type", + } + + @property + def arraydtick(self): + """ + The stride between grid lines along the axis + + The 'arraydtick' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["arraydtick"] + + @arraydtick.setter + def arraydtick(self, val): + self["arraydtick"] = val + + @property + def arraytick0(self): + """ + The starting index of grid lines along the axis + + The 'arraytick0' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["arraytick0"] + + @arraytick0.setter + def arraytick0(self, val): + self["arraytick0"] = val + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided, then `autorange` is set to False. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def cheatertype(self): + """ + The 'cheatertype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['index', 'value'] + + Returns + ------- + Any + """ + return self["cheatertype"] + + @cheatertype.setter + def cheatertype(self, val): + self["cheatertype"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + The stride between grid lines along the axis + + The 'dtick' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def endline(self): + """ + Determines whether or not a line is drawn at along the final + value of this axis. If True, the end line is drawn on top of + the grid lines. + + The 'endline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["endline"] + + @endline.setter + def endline(self, val): + self["endline"] = val + + @property + def endlinecolor(self): + """ + Sets the line color of the end line. + + The 'endlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["endlinecolor"] + + @endlinecolor.setter + def endlinecolor(self, val): + self["endlinecolor"] = val + + @property + def endlinewidth(self): + """ + Sets the width (in px) of the end line. + + The 'endlinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["endlinewidth"] + + @endlinewidth.setter + def endlinewidth(self, val): + self["endlinewidth"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def fixedrange(self): + """ + Determines whether or not this axis is zoom-able. If true, then + zoom is disabled. + + The 'fixedrange' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["fixedrange"] + + @fixedrange.setter + def fixedrange(self, val): + self["fixedrange"] = val + + @property + def gridcolor(self): + """ + Sets the axis line color. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the axis line. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def labelpadding(self): + """ + Extra padding between label and the axis + + The 'labelpadding' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["labelpadding"] + + @labelpadding.setter + def labelpadding(self, val): + self["labelpadding"] = val + + @property + def labelprefix(self): + """ + Sets a axis label prefix. + + The 'labelprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelprefix"] + + @labelprefix.setter + def labelprefix(self, val): + self["labelprefix"] = val + + @property + def labelsuffix(self): + """ + Sets a axis label suffix. + + The 'labelsuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelsuffix"] + + @labelsuffix.setter + def labelsuffix(self, val): + self["labelsuffix"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def minorgridcolor(self): + """ + Sets the color of the grid lines. + + The 'minorgridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["minorgridcolor"] + + @minorgridcolor.setter + def minorgridcolor(self, val): + self["minorgridcolor"] = val + + @property + def minorgridcount(self): + """ + Sets the number of minor grid ticks per major grid tick + + The 'minorgridcount' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["minorgridcount"] + + @minorgridcount.setter + def minorgridcount(self, val): + self["minorgridcount"] = val + + @property + def minorgriddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'minorgriddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["minorgriddash"] + + @minorgriddash.setter + def minorgriddash(self, val): + self["minorgriddash"] = val + + @property + def minorgridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'minorgridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minorgridwidth"] + + @minorgridwidth.setter + def minorgridwidth(self, val): + self["minorgridwidth"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether axis labels are drawn on the low side, the + high side, both, or neither side of the axis. + + The 'showticklabels' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'end', 'both', 'none'] + + Returns + ------- + Any + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def smoothing(self): + """ + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def startline(self): + """ + Determines whether or not a line is drawn at along the starting + value of this axis. If True, the start line is drawn on top of + the grid lines. + + The 'startline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["startline"] + + @startline.setter + def startline(self, val): + self["startline"] = val + + @property + def startlinecolor(self): + """ + Sets the line color of the start line. + + The 'startlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["startlinecolor"] + + @startlinecolor.setter + def startlinecolor(self, val): + self["startlinecolor"] = val + + @property + def startlinewidth(self): + """ + Sets the width (in px) of the start line. + + The 'startlinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["startlinewidth"] + + @startlinewidth.setter + def startlinewidth(self, val): + self["startlinewidth"] = val + + @property + def tick0(self): + """ + The starting index of grid lines along the axis + + The 'tick0' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.aaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.carpet.aaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.carpet.aaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.carpet.aaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.carpet.aaxis.tickformatstopdefaults), sets + the default property values to use for elements of + carpet.aaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.carpet.aaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def tickmode(self): + """ + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.aaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.carpet.aaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def _prop_descriptions(self): + return """\ + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the axis line. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minexponent + Hide SI prefix for 10^n if |n| is below this number + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgriddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.carpet.aaxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.aaxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + title + :class:`plotly.graph_objects.carpet.aaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + """ + + def __init__( + self, + arg=None, + arraydtick=None, + arraytick0=None, + autorange=None, + autotypenumbers=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + cheatertype=None, + color=None, + dtick=None, + endline=None, + endlinecolor=None, + endlinewidth=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + griddash=None, + gridwidth=None, + labelalias=None, + labelpadding=None, + labelprefix=None, + labelsuffix=None, + linecolor=None, + linewidth=None, + minexponent=None, + minorgridcolor=None, + minorgridcount=None, + minorgriddash=None, + minorgridwidth=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + smoothing=None, + startline=None, + startlinecolor=None, + startlinewidth=None, + tick0=None, + tickangle=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + tickmode=None, + tickprefix=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + title=None, + type=None, + **kwargs, + ): + """ + Construct a new Aaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.carpet.Aaxis` + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the axis line. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minexponent + Hide SI prefix for 10^n if |n| is below this number + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgriddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.carpet.aaxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.aaxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + title + :class:`plotly.graph_objects.carpet.aaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + + Returns + ------- + Aaxis + """ + super().__init__("aaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.Aaxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.Aaxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("arraydtick", arg, arraydtick) + self._set_property("arraytick0", arg, arraytick0) + self._set_property("autorange", arg, autorange) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("cheatertype", arg, cheatertype) + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("endline", arg, endline) + self._set_property("endlinecolor", arg, endlinecolor) + self._set_property("endlinewidth", arg, endlinewidth) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("fixedrange", arg, fixedrange) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("labelalias", arg, labelalias) + self._set_property("labelpadding", arg, labelpadding) + self._set_property("labelprefix", arg, labelprefix) + self._set_property("labelsuffix", arg, labelsuffix) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("minexponent", arg, minexponent) + self._set_property("minorgridcolor", arg, minorgridcolor) + self._set_property("minorgridcount", arg, minorgridcount) + self._set_property("minorgriddash", arg, minorgriddash) + self._set_property("minorgridwidth", arg, minorgridwidth) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("smoothing", arg, smoothing) + self._set_property("startline", arg, startline) + self._set_property("startlinecolor", arg, startlinecolor) + self._set_property("startlinewidth", arg, startlinewidth) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_baxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_baxis.py new file mode 100644 index 0000000..f268f69 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_baxis.py @@ -0,0 +1,1850 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Baxis(_BaseTraceHierarchyType): + _parent_path_str = "carpet" + _path_str = "carpet.baxis" + _valid_props = { + "arraydtick", + "arraytick0", + "autorange", + "autotypenumbers", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "cheatertype", + "color", + "dtick", + "endline", + "endlinecolor", + "endlinewidth", + "exponentformat", + "fixedrange", + "gridcolor", + "griddash", + "gridwidth", + "labelalias", + "labelpadding", + "labelprefix", + "labelsuffix", + "linecolor", + "linewidth", + "minexponent", + "minorgridcolor", + "minorgridcount", + "minorgriddash", + "minorgridwidth", + "nticks", + "range", + "rangemode", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "smoothing", + "startline", + "startlinecolor", + "startlinewidth", + "tick0", + "tickangle", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "tickmode", + "tickprefix", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "title", + "type", + } + + @property + def arraydtick(self): + """ + The stride between grid lines along the axis + + The 'arraydtick' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["arraydtick"] + + @arraydtick.setter + def arraydtick(self, val): + self["arraydtick"] = val + + @property + def arraytick0(self): + """ + The starting index of grid lines along the axis + + The 'arraytick0' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["arraytick0"] + + @arraytick0.setter + def arraytick0(self, val): + self["arraytick0"] = val + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided, then `autorange` is set to False. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def cheatertype(self): + """ + The 'cheatertype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['index', 'value'] + + Returns + ------- + Any + """ + return self["cheatertype"] + + @cheatertype.setter + def cheatertype(self, val): + self["cheatertype"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + The stride between grid lines along the axis + + The 'dtick' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def endline(self): + """ + Determines whether or not a line is drawn at along the final + value of this axis. If True, the end line is drawn on top of + the grid lines. + + The 'endline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["endline"] + + @endline.setter + def endline(self, val): + self["endline"] = val + + @property + def endlinecolor(self): + """ + Sets the line color of the end line. + + The 'endlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["endlinecolor"] + + @endlinecolor.setter + def endlinecolor(self, val): + self["endlinecolor"] = val + + @property + def endlinewidth(self): + """ + Sets the width (in px) of the end line. + + The 'endlinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["endlinewidth"] + + @endlinewidth.setter + def endlinewidth(self, val): + self["endlinewidth"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def fixedrange(self): + """ + Determines whether or not this axis is zoom-able. If true, then + zoom is disabled. + + The 'fixedrange' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["fixedrange"] + + @fixedrange.setter + def fixedrange(self, val): + self["fixedrange"] = val + + @property + def gridcolor(self): + """ + Sets the axis line color. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the axis line. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def labelpadding(self): + """ + Extra padding between label and the axis + + The 'labelpadding' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["labelpadding"] + + @labelpadding.setter + def labelpadding(self, val): + self["labelpadding"] = val + + @property + def labelprefix(self): + """ + Sets a axis label prefix. + + The 'labelprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelprefix"] + + @labelprefix.setter + def labelprefix(self, val): + self["labelprefix"] = val + + @property + def labelsuffix(self): + """ + Sets a axis label suffix. + + The 'labelsuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelsuffix"] + + @labelsuffix.setter + def labelsuffix(self, val): + self["labelsuffix"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def minorgridcolor(self): + """ + Sets the color of the grid lines. + + The 'minorgridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["minorgridcolor"] + + @minorgridcolor.setter + def minorgridcolor(self, val): + self["minorgridcolor"] = val + + @property + def minorgridcount(self): + """ + Sets the number of minor grid ticks per major grid tick + + The 'minorgridcount' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["minorgridcount"] + + @minorgridcount.setter + def minorgridcount(self, val): + self["minorgridcount"] = val + + @property + def minorgriddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'minorgriddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["minorgriddash"] + + @minorgriddash.setter + def minorgriddash(self, val): + self["minorgriddash"] = val + + @property + def minorgridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'minorgridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minorgridwidth"] + + @minorgridwidth.setter + def minorgridwidth(self, val): + self["minorgridwidth"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether axis labels are drawn on the low side, the + high side, both, or neither side of the axis. + + The 'showticklabels' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['start', 'end', 'both', 'none'] + + Returns + ------- + Any + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def smoothing(self): + """ + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def startline(self): + """ + Determines whether or not a line is drawn at along the starting + value of this axis. If True, the start line is drawn on top of + the grid lines. + + The 'startline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["startline"] + + @startline.setter + def startline(self, val): + self["startline"] = val + + @property + def startlinecolor(self): + """ + Sets the line color of the start line. + + The 'startlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["startlinecolor"] + + @startlinecolor.setter + def startlinecolor(self, val): + self["startlinecolor"] = val + + @property + def startlinewidth(self): + """ + Sets the width (in px) of the start line. + + The 'startlinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["startlinewidth"] + + @startlinewidth.setter + def startlinewidth(self, val): + self["startlinewidth"] = val + + @property + def tick0(self): + """ + The starting index of grid lines along the axis + + The 'tick0' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.baxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.carpet.baxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.carpet.baxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.carpet.baxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.carpet.baxis.tickformatstopdefaults), sets + the default property values to use for elements of + carpet.baxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.baxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.carpet.baxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def tickmode(self): + """ + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.baxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.carpet.baxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def _prop_descriptions(self): + return """\ + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the axis line. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minexponent + Hide SI prefix for 10^n if |n| is below this number + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgriddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.carpet.baxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .baxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.baxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + title + :class:`plotly.graph_objects.carpet.baxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + """ + + def __init__( + self, + arg=None, + arraydtick=None, + arraytick0=None, + autorange=None, + autotypenumbers=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + cheatertype=None, + color=None, + dtick=None, + endline=None, + endlinecolor=None, + endlinewidth=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + griddash=None, + gridwidth=None, + labelalias=None, + labelpadding=None, + labelprefix=None, + labelsuffix=None, + linecolor=None, + linewidth=None, + minexponent=None, + minorgridcolor=None, + minorgridcount=None, + minorgriddash=None, + minorgridwidth=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + smoothing=None, + startline=None, + startlinecolor=None, + startlinewidth=None, + tick0=None, + tickangle=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + tickmode=None, + tickprefix=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + title=None, + type=None, + **kwargs, + ): + """ + Construct a new Baxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.carpet.Baxis` + arraydtick + The stride between grid lines along the axis + arraytick0 + The starting index of grid lines along the axis + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided, then `autorange` + is set to False. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + cheatertype + + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + The stride between grid lines along the axis + endline + Determines whether or not a line is drawn at along the + final value of this axis. If True, the end line is + drawn on top of the grid lines. + endlinecolor + Sets the line color of the end line. + endlinewidth + Sets the width (in px) of the end line. + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the axis line color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the axis line. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + labelpadding + Extra padding between label and the axis + labelprefix + Sets a axis label prefix. + labelsuffix + Sets a axis label suffix. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minexponent + Hide SI prefix for 10^n if |n| is below this number + minorgridcolor + Sets the color of the grid lines. + minorgridcount + Sets the number of minor grid ticks per major grid tick + minorgriddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + minorgridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether axis labels are drawn on the low + side, the high side, both, or neither side of the axis. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + smoothing + + startline + Determines whether or not a line is drawn at along the + starting value of this axis. If True, the start line is + drawn on top of the grid lines. + startlinecolor + Sets the line color of the start line. + startlinewidth + Sets the width (in px) of the start line. + tick0 + The starting index of grid lines along the axis + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.carpet.baxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.carpet + .baxis.tickformatstopdefaults), sets the default + property values to use for elements of + carpet.baxis.tickformatstops + tickmode + + tickprefix + Sets a tick label prefix. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + title + :class:`plotly.graph_objects.carpet.baxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + + Returns + ------- + Baxis + """ + super().__init__("baxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.Baxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.Baxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("arraydtick", arg, arraydtick) + self._set_property("arraytick0", arg, arraytick0) + self._set_property("autorange", arg, autorange) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("cheatertype", arg, cheatertype) + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("endline", arg, endline) + self._set_property("endlinecolor", arg, endlinecolor) + self._set_property("endlinewidth", arg, endlinewidth) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("fixedrange", arg, fixedrange) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("labelalias", arg, labelalias) + self._set_property("labelpadding", arg, labelpadding) + self._set_property("labelprefix", arg, labelprefix) + self._set_property("labelsuffix", arg, labelsuffix) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("minexponent", arg, minexponent) + self._set_property("minorgridcolor", arg, minorgridcolor) + self._set_property("minorgridcount", arg, minorgridcount) + self._set_property("minorgriddash", arg, minorgriddash) + self._set_property("minorgridwidth", arg, minorgridwidth) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("smoothing", arg, smoothing) + self._set_property("startline", arg, startline) + self._set_property("startlinecolor", arg, startlinecolor) + self._set_property("startlinewidth", arg, startlinewidth) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_font.py new file mode 100644 index 0000000..d41425c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_font.py @@ -0,0 +1,333 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "carpet" + _path_str = "carpet.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + The default font used for axis & tick labels on this carpet + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.carpet.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_legendgrouptitle.py new file mode 100644 index 0000000..94d0b97 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "carpet" + _path_str = "carpet.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.carpet.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_stream.py new file mode 100644 index 0000000..47c3ae7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "carpet" + _path_str = "carpet.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.carpet.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickfont.py new file mode 100644 index 0000000..32256e9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "carpet.aaxis" + _path_str = "carpet.aaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.aaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.aaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.aaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickformatstop.py new file mode 100644 index 0000000..5a757be --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "carpet.aaxis" + _path_str = "carpet.aaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.aaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.aaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_title.py new file mode 100644 index 0000000..265e4e1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/_title.py @@ -0,0 +1,130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "carpet.aaxis" + _path_str = "carpet.aaxis.title" + _valid_props = {"font", "offset", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.carpet.aaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def offset(self): + """ + An additional amount by which to offset the title from the tick + labels, given in pixels. + + The 'offset' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + offset + An additional amount by which to offset the title from + the tick labels, given in pixels. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.aaxis.Title` + font + Sets this axis' title font. + offset + An additional amount by which to offset the title from + the tick labels, given in pixels. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.aaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.aaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("offset", arg, offset) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/_font.py new file mode 100644 index 0000000..398ca78 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/aaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "carpet.aaxis.title" + _path_str = "carpet.aaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.aaxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.aaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.aaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickfont.py new file mode 100644 index 0000000..0085dc5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "carpet.baxis" + _path_str = "carpet.baxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.baxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.baxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.baxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickformatstop.py new file mode 100644 index 0000000..f034d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "carpet.baxis" + _path_str = "carpet.baxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.baxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.baxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.baxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_title.py new file mode 100644 index 0000000..b1e66dd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/_title.py @@ -0,0 +1,130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "carpet.baxis" + _path_str = "carpet.baxis.title" + _valid_props = {"font", "offset", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.carpet.baxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.carpet.baxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def offset(self): + """ + An additional amount by which to offset the title from the tick + labels, given in pixels. + + The 'offset' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + offset + An additional amount by which to offset the title from + the tick labels, given in pixels. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, offset=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.baxis.Title` + font + Sets this axis' title font. + offset + An additional amount by which to offset the title from + the tick labels, given in pixels. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.baxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.baxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("offset", arg, offset) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/_font.py new file mode 100644 index 0000000..58b3595 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/baxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "carpet.baxis.title" + _path_str = "carpet.baxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.baxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.baxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.baxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/_font.py new file mode 100644 index 0000000..d8f6eb1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/carpet/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "carpet.legendgrouptitle" + _path_str = "carpet.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.carpet.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.carpet.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.carpet.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/__init__.py new file mode 100644 index 0000000..bbdf79a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/__init__.py @@ -0,0 +1,40 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".colorbar", + ".hoverlabel", + ".legendgrouptitle", + ".marker", + ".selected", + ".unselected", + ], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_colorbar.py new file mode 100644 index 0000000..615e866 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_colorbar.py @@ -0,0 +1,1721 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.choropleth.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.choropleth.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.choropleth.col + orbar.tickformatstopdefaults), sets the default property values + to use for elements of choropleth.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.choropleth.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + leth.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + choropleth.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.choropleth.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.choropleth.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + leth.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + choropleth.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.choropleth.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_hoverlabel.py new file mode 100644 index 0000000..3c8294e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choropleth.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_legendgrouptitle.py new file mode 100644 index 0000000..c568234 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choropleth.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_marker.py new file mode 100644 index 0000000..212bde1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_marker.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.marker" + _valid_props = {"line", "opacity", "opacitysrc"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.choropleth.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the locations. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.choropleth.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + """ + + def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.Marker` + line + :class:`plotly.graph_objects.choropleth.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_selected.py new file mode 100644 index 0000000..ff0cafd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choropleth.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.choropleth.selected.Marker + ` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.Selected` + marker + :class:`plotly.graph_objects.choropleth.selected.Marker + ` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_stream.py new file mode 100644 index 0000000..84624f8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_unselected.py new file mode 100644 index 0000000..68ef597 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "choropleth" + _path_str = "choropleth.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choropleth.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.choropleth.unselected.Mark + er` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.Unselected` + marker + :class:`plotly.graph_objects.choropleth.unselected.Mark + er` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickfont.py new file mode 100644 index 0000000..4809642 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.colorbar" + _path_str = "choropleth.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py new file mode 100644 index 0000000..63aa29c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.colorbar" + _path_str = "choropleth.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choropleth.col + orbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_title.py new file mode 100644 index 0000000..1ae8cfc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.colorbar" + _path_str = "choropleth.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choropleth.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choropleth.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/_font.py new file mode 100644 index 0000000..69df048 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.colorbar.title" + _path_str = "choropleth.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choropleth.col + orbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/_font.py new file mode 100644 index 0000000..5892c80 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.hoverlabel" + _path_str = "choropleth.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/_font.py new file mode 100644 index 0000000..79c05c7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.legendgrouptitle" + _path_str = "choropleth.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choropleth.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/_line.py new file mode 100644 index 0000000..bf9d861 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/marker/_line.py @@ -0,0 +1,171 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.marker" + _path_str = "choropleth.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.marker.Line` + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/_marker.py new file mode 100644 index 0000000..97eaa76 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/selected/_marker.py @@ -0,0 +1,77 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.selected" + _path_str = "choropleth.selected.marker" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.selected.Marker` + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/_marker.py new file mode 100644 index 0000000..d7d5881 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choropleth/unselected/_marker.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choropleth.unselected" + _path_str = "choropleth.unselected.marker" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choropleth.unselected.Marker` + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choropleth.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choropleth.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/__init__.py new file mode 100644 index 0000000..bbdf79a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/__init__.py @@ -0,0 +1,40 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".colorbar", + ".hoverlabel", + ".legendgrouptitle", + ".marker", + ".selected", + ".unselected", + ], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_colorbar.py new file mode 100644 index 0000000..1a40618 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.choroplethmap.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.choroplethmap.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.choroplethmap. + colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + choroplethmap.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.choroplethmap.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + lethmap.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + choroplethmap.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.choroplethmap.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.choroplethmap.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + lethmap.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + choroplethmap.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.choroplethmap.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_hoverlabel.py new file mode 100644 index 0000000..761e481 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_legendgrouptitle.py new file mode 100644 index 0000000..ddfbdfd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_marker.py new file mode 100644 index 0000000..0f7f498 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_marker.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.marker" + _valid_props = {"line", "opacity", "opacitysrc"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the locations. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.choroplethmap.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + """ + + def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.Marker` + line + :class:`plotly.graph_objects.choroplethmap.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_selected.py new file mode 100644 index 0000000..e68c38f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.choroplethmap.selected.Mar + ker` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.Selected` + marker + :class:`plotly.graph_objects.choroplethmap.selected.Mar + ker` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_stream.py new file mode 100644 index 0000000..348b27d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_unselected.py new file mode 100644 index 0000000..fcbf6a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap" + _path_str = "choroplethmap.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.choroplethmap.unselected.M + arker` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.Unselected` + marker + :class:`plotly.graph_objects.choroplethmap.unselected.M + arker` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickfont.py new file mode 100644 index 0000000..b20f689 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.colorbar" + _path_str = "choroplethmap.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py new file mode 100644 index 0000000..f13d83f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.colorbar" + _path_str = "choroplethmap.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_title.py new file mode 100644 index 0000000..c5f12b3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.colorbar" + _path_str = "choroplethmap.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmap.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choroplethmap.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/_font.py new file mode 100644 index 0000000..ff94542 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.colorbar.title" + _path_str = "choroplethmap.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/_font.py new file mode 100644 index 0000000..dda15f3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.hoverlabel" + _path_str = "choroplethmap.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/_font.py new file mode 100644 index 0000000..4d2b65b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.legendgrouptitle" + _path_str = "choroplethmap.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/_line.py new file mode 100644 index 0000000..77c7928 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/marker/_line.py @@ -0,0 +1,171 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.marker" + _path_str = "choroplethmap.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmap.marker.Line` + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/_marker.py new file mode 100644 index 0000000..9f254a9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/selected/_marker.py @@ -0,0 +1,77 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.selected" + _path_str = "choroplethmap.selected.marker" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + selected.Marker` + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/_marker.py new file mode 100644 index 0000000..27e2a34 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmap/unselected/_marker.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmap.unselected" + _path_str = "choroplethmap.unselected.marker" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmap. + unselected.Marker` + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmap.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmap.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/__init__.py new file mode 100644 index 0000000..bbdf79a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/__init__.py @@ -0,0 +1,40 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".colorbar", + ".hoverlabel", + ".legendgrouptitle", + ".marker", + ".selected", + ".unselected", + ], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_colorbar.py new file mode 100644 index 0000000..135c851 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.choroplethmapb + ox.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + choroplethmapbox.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.choroplethmapbo + x.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + lethmapbox.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + choroplethmapbox.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.choroplethmapbox.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.choroplethmapbo + x.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.chorop + lethmapbox.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + choroplethmapbox.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.choroplethmapbox.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_hoverlabel.py new file mode 100644 index 0000000..1c8312e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_legendgrouptitle.py new file mode 100644 index 0000000..2445531 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_marker.py new file mode 100644 index 0000000..d4b24d4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_marker.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.marker" + _valid_props = {"line", "opacity", "opacitysrc"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the locations. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.choroplethmapbox.marker.Li + ne` instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + """ + + def __init__(self, arg=None, line=None, opacity=None, opacitysrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.Marker` + line + :class:`plotly.graph_objects.choroplethmapbox.marker.Li + ne` instance or dict with compatible properties + opacity + Sets the opacity of the locations. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_selected.py new file mode 100644 index 0000000..d7c4b13 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.choroplethmapbox.selected. + Marker` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.Selected` + marker + :class:`plotly.graph_objects.choroplethmapbox.selected. + Marker` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_stream.py new file mode 100644 index 0000000..1698554 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_unselected.py new file mode 100644 index 0000000..ad22ba4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox" + _path_str = "choroplethmapbox.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.choroplethmapbox.unselecte + d.Marker` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.Unselected` + marker + :class:`plotly.graph_objects.choroplethmapbox.unselecte + d.Marker` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py new file mode 100644 index 0000000..b44c18a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.colorbar" + _path_str = "choroplethmapbox.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py new file mode 100644 index 0000000..30794de --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.colorbar" + _path_str = "choroplethmapbox.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_title.py new file mode 100644 index 0000000..f96e32e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.colorbar" + _path_str = "choroplethmapbox.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.choroplethmapbox.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py new file mode 100644 index 0000000..1fd1fc2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.colorbar.title" + _path_str = "choroplethmapbox.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py new file mode 100644 index 0000000..20d0759 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.hoverlabel" + _path_str = "choroplethmapbox.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/_font.py new file mode 100644 index 0000000..21b889a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.legendgrouptitle" + _path_str = "choroplethmapbox.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/_line.py new file mode 100644 index 0000000..47d10d3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/marker/_line.py @@ -0,0 +1,171 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.marker" + _path_str = "choroplethmapbox.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.choroplethmapbox.marker.Line` + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/_marker.py new file mode 100644 index 0000000..4b7a35d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/selected/_marker.py @@ -0,0 +1,77 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.selected" + _path_str = "choroplethmapbox.selected.marker" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.selected.Marker` + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/_marker.py new file mode 100644 index 0000000..5da2bb2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/choroplethmapbox/unselected/_marker.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "choroplethmapbox.unselected" + _path_str = "choroplethmapbox.unselected.marker" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.choroplethmapb + ox.unselected.Marker` + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.choroplethmapbox.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.choroplethmapbox.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/__init__.py new file mode 100644 index 0000000..c523ad1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/__init__.py @@ -0,0 +1,28 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._lighting import Lighting + from ._lightposition import Lightposition + from ._stream import Stream + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._lighting.Lighting", + "._lightposition.Lightposition", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_colorbar.py new file mode 100644 index 0000000..8fa8105 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_colorbar.py @@ -0,0 +1,1721 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "cone" + _path_str = "cone.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.cone.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.cone.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.cone.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.cone.colorbar.tickformatstopdefaults), + sets the default property values to use for elements of + cone.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.cone.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.cone.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.cone.colorbar.T + ickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.cone.c + olorbar.tickformatstopdefaults), sets the default + property values to use for elements of + cone.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.cone.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.cone.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.cone.colorbar.T + ickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.cone.c + olorbar.tickformatstopdefaults), sets the default + property values to use for elements of + cone.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.cone.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_hoverlabel.py new file mode 100644 index 0000000..a2d769c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "cone" + _path_str = "cone.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.cone.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_legendgrouptitle.py new file mode 100644 index 0000000..2028ac4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "cone" + _path_str = "cone.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.cone.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lighting.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lighting.py new file mode 100644 index 0000000..e8cfa31 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lighting.py @@ -0,0 +1,259 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + _parent_path_str = "cone" + _path_str = "cone.lighting" + _valid_props = { + "ambient", + "diffuse", + "facenormalsepsilon", + "fresnel", + "roughness", + "specular", + "vertexnormalsepsilon", + } + + @property + def ambient(self): + """ + Ambient light increases overall color visibility but can wash + out the image. + + The 'ambient' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ambient"] + + @ambient.setter + def ambient(self, val): + self["ambient"] = val + + @property + def diffuse(self): + """ + Represents the extent that incident rays are reflected in a + range of angles. + + The 'diffuse' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["diffuse"] + + @diffuse.setter + def diffuse(self, val): + self["diffuse"] = val + + @property + def facenormalsepsilon(self): + """ + Epsilon for face normals calculation avoids math issues arising + from degenerate geometry. + + The 'facenormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["facenormalsepsilon"] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self["facenormalsepsilon"] = val + + @property + def fresnel(self): + """ + Represents the reflectance as a dependency of the viewing + angle; e.g. paper is reflective when viewing it from the edge + of the paper (almost 90 degrees), causing shine. + + The 'fresnel' property is a number and may be specified as: + - An int or float in the interval [0, 5] + + Returns + ------- + int|float + """ + return self["fresnel"] + + @fresnel.setter + def fresnel(self, val): + self["fresnel"] = val + + @property + def roughness(self): + """ + Alters specular reflection; the rougher the surface, the wider + and less contrasty the shine. + + The 'roughness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["roughness"] + + @roughness.setter + def roughness(self, val): + self["roughness"] = val + + @property + def specular(self): + """ + Represents the level that incident rays are reflected in a + single direction, causing shine. + + The 'specular' property is a number and may be specified as: + - An int or float in the interval [0, 2] + + Returns + ------- + int|float + """ + return self["specular"] + + @specular.setter + def specular(self, val): + self["specular"] = val + + @property + def vertexnormalsepsilon(self): + """ + Epsilon for vertex normals calculation avoids math issues + arising from degenerate geometry. + + The 'vertexnormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["vertexnormalsepsilon"] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self["vertexnormalsepsilon"] = val + + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs, + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.cone.Lighting` + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super().__init__("lighting") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.Lighting +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.Lighting`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("ambient", arg, ambient) + self._set_property("diffuse", arg, diffuse) + self._set_property("facenormalsepsilon", arg, facenormalsepsilon) + self._set_property("fresnel", arg, fresnel) + self._set_property("roughness", arg, roughness) + self._set_property("specular", arg, specular) + self._set_property("vertexnormalsepsilon", arg, vertexnormalsepsilon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lightposition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lightposition.py new file mode 100644 index 0000000..13775d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_lightposition.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + _parent_path_str = "cone" + _path_str = "cone.lightposition" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Numeric vector, representing the X coordinate for each vertex. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Numeric vector, representing the Y coordinate for each vertex. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Numeric vector, representing the Z coordinate for each vertex. + + The 'z' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.Lightposition` + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super().__init__("lightposition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.Lightposition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.Lightposition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_stream.py new file mode 100644 index 0000000..6660a2b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "cone" + _path_str = "cone.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.cone.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickfont.py new file mode 100644 index 0000000..4b28730 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "cone.colorbar" + _path_str = "cone.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickformatstop.py new file mode 100644 index 0000000..740f390 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "cone.colorbar" + _path_str = "cone.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_title.py new file mode 100644 index 0000000..66d5ec4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "cone.colorbar" + _path_str = "cone.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.cone.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.cone.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/_font.py new file mode 100644 index 0000000..08e5f3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "cone.colorbar.title" + _path_str = "cone.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/_font.py new file mode 100644 index 0000000..b24ef20 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "cone.hoverlabel" + _path_str = "cone.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/_font.py new file mode 100644 index 0000000..90b723a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/cone/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "cone.legendgrouptitle" + _path_str = "cone.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.cone.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.cone.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.cone.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/__init__.py new file mode 100644 index 0000000..335ba25 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/__init__.py @@ -0,0 +1,31 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._contours import Contours + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._stream import Stream + from ._textfont import Textfont + from . import colorbar + from . import contours + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".contours", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._contours.Contours", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._stream.Stream", + "._textfont.Textfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_colorbar.py new file mode 100644 index 0000000..6c36df4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.contour.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.contour.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.contour.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.contour.colorbar.tickformatstopdefaults), + sets the default property values to use for elements of + contour.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.contour.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.contour.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.contour.colorba + r.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + r.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + contour.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.contour.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.contour.colorba + r.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + r.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + contour.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.contour.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_contours.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_contours.py new file mode 100644 index 0000000..122d8d2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_contours.py @@ -0,0 +1,436 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.contours" + _valid_props = { + "coloring", + "end", + "labelfont", + "labelformat", + "operation", + "showlabels", + "showlines", + "size", + "start", + "type", + "value", + } + + @property + def coloring(self): + """ + Determines the coloring method showing the contour values. If + "fill", coloring is done evenly between each contour level If + "heatmap", a heatmap gradient coloring is applied between each + contour level. If "lines", coloring is done on the contour + lines. If "none", no coloring is applied on this trace. + + The 'coloring' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'heatmap', 'lines', 'none'] + + Returns + ------- + Any + """ + return self["coloring"] + + @coloring.setter + def coloring(self, val): + self["coloring"] = val + + @property + def end(self): + """ + Sets the end contour level value. Must be more than + `contours.start` + + The 'end' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def labelfont(self): + """ + Sets the font used for labeling the contour levels. The default + color comes from the lines, if shown. The default family and + size come from `layout.font`. + + The 'labelfont' property is an instance of Labelfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.contours.Labelfont` + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Returns + ------- + plotly.graph_objs.contour.contours.Labelfont + """ + return self["labelfont"] + + @labelfont.setter + def labelfont(self, val): + self["labelfont"] = val + + @property + def labelformat(self): + """ + Sets the contour label formatting rule using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'labelformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelformat"] + + @labelformat.setter + def labelformat(self, val): + self["labelformat"] = val + + @property + def operation(self): + """ + Sets the constraint operation. "=" keeps regions equal to + `value` "<" and "<=" keep regions less than `value` ">" and + ">=" keep regions greater than `value` "[]", "()", "[)", and + "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", + "](", ")[" keep regions outside `value[0]` to value[1]` Open + vs. closed intervals make no difference to constraint display, + but all versions are allowed for consistency with filter + transforms. + + The 'operation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] + + Returns + ------- + Any + """ + return self["operation"] + + @operation.setter + def operation(self, val): + self["operation"] = val + + @property + def showlabels(self): + """ + Determines whether to label the contour lines with their + values. + + The 'showlabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlabels"] + + @showlabels.setter + def showlabels(self, val): + self["showlabels"] = val + + @property + def showlines(self): + """ + Determines whether or not the contour lines are drawn. Has an + effect only if `contours.coloring` is set to "fill". + + The 'showlines' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlines"] + + @showlines.setter + def showlines(self, val): + self["showlines"] = val + + @property + def size(self): + """ + Sets the step between each contour level. Must be positive. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting contour level value. Must be less than + `contours.end` + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def type(self): + """ + If `levels`, the data is represented as a contour plot with + multiple levels displayed. If `constraint`, the data is + represented as constraints with the invalid region shaded as + specified by the `operation` and `value` parameters. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['levels', 'constraint'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value or values of the constraint boundary. When + `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of + two numbers where the first is the lower bound and the second + is the upper bound. + + The 'value' property accepts values of any type + + Returns + ------- + Any + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + """ + + def __init__( + self, + arg=None, + coloring=None, + end=None, + labelfont=None, + labelformat=None, + operation=None, + showlabels=None, + showlines=None, + size=None, + start=None, + type=None, + value=None, + **kwargs, + ): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.Contours` + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + + Returns + ------- + Contours + """ + super().__init__("contours") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.Contours +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.Contours`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("coloring", arg, coloring) + self._set_property("end", arg, end) + self._set_property("labelfont", arg, labelfont) + self._set_property("labelformat", arg, labelformat) + self._set_property("operation", arg, operation) + self._set_property("showlabels", arg, showlabels) + self._set_property("showlines", arg, showlines) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_hoverlabel.py new file mode 100644 index 0000000..b8731b5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.contour.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_legendgrouptitle.py new file mode 100644 index 0000000..9566a13 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.contour.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_line.py new file mode 100644 index 0000000..9090ff7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_line.py @@ -0,0 +1,175 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.line" + _valid_props = {"color", "dash", "smoothing", "width"} + + @property + def color(self): + """ + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def smoothing(self): + """ + Sets the amount of smoothing for the contour lines, where 0 + corresponds to no smoothing. + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the contour line width in (in px) Defaults to 0.5 when + `contours.type` is "levels". Defaults to 2 when `contour.type` + is "constraint". + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the contour line width in (in px) Defaults to 0.5 + when `contours.type` is "levels". Defaults to 2 when + `contour.type` is "constraint". + """ + + def __init__( + self, arg=None, color=None, dash=None, smoothing=None, width=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contour.Line` + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the contour line width in (in px) Defaults to 0.5 + when `contours.type` is "levels". Defaults to 2 when + `contour.type` is "constraint". + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_stream.py new file mode 100644 index 0000000..0fc45b6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_textfont.py new file mode 100644 index 0000000..281f19b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/_textfont.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "contour" + _path_str = "contour.textfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + For this trace it only has an effect if `coloring` is set to + "heatmap". Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickfont.py new file mode 100644 index 0000000..5d83a64 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "contour.colorbar" + _path_str = "contour.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickformatstop.py new file mode 100644 index 0000000..3ec4bfd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "contour.colorbar" + _path_str = "contour.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contour.colorb + ar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_title.py new file mode 100644 index 0000000..111d848 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "contour.colorbar" + _path_str = "contour.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.contour.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.contour.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/_font.py new file mode 100644 index 0000000..4d09b4e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "contour.colorbar.title" + _path_str = "contour.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/__init__.py new file mode 100644 index 0000000..48d6bb6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._labelfont import Labelfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._labelfont.Labelfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/_labelfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/_labelfont.py new file mode 100644 index 0000000..da43317 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/contours/_labelfont.py @@ -0,0 +1,336 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + _parent_path_str = "contour.contours" + _path_str = "contour.contours.labelfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Labelfont object + + Sets the font used for labeling the contour levels. The default + color comes from the lines, if shown. The default family and + size come from `layout.font`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.contours.Labelfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Labelfont + """ + super().__init__("labelfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.contours.Labelfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.contours.Labelfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/_font.py new file mode 100644 index 0000000..6da93a5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "contour.hoverlabel" + _path_str = "contour.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contour.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/_font.py new file mode 100644 index 0000000..71f9700 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contour/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "contour.legendgrouptitle" + _path_str = "contour.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contour.legend + grouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contour.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contour.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/__init__.py new file mode 100644 index 0000000..8d9cb5e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/__init__.py @@ -0,0 +1,26 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._contours import Contours + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._stream import Stream + from . import colorbar + from . import contours + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".contours", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._contours.Contours", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_colorbar.py new file mode 100644 index 0000000..0ae3122 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet" + _path_str = "contourcarpet.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.contourcarpet.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.contourcarpet. + colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + contourcarpet.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.contourcarpet.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + rcarpet.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + contourcarpet.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.contourcarpet.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contourcarpet.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.contourcarpet.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.contou + rcarpet.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + contourcarpet.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.contourcarpet.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_contours.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_contours.py new file mode 100644 index 0000000..0b5e3fb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_contours.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet" + _path_str = "contourcarpet.contours" + _valid_props = { + "coloring", + "end", + "labelfont", + "labelformat", + "operation", + "showlabels", + "showlines", + "size", + "start", + "type", + "value", + } + + @property + def coloring(self): + """ + Determines the coloring method showing the contour values. If + "fill", coloring is done evenly between each contour level If + "lines", coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + + The 'coloring' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'lines', 'none'] + + Returns + ------- + Any + """ + return self["coloring"] + + @coloring.setter + def coloring(self, val): + self["coloring"] = val + + @property + def end(self): + """ + Sets the end contour level value. Must be more than + `contours.start` + + The 'end' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def labelfont(self): + """ + Sets the font used for labeling the contour levels. The default + color comes from the lines, if shown. The default family and + size come from `layout.font`. + + The 'labelfont' property is an instance of Labelfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.contours.Labelfont` + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.contours.Labelfont + """ + return self["labelfont"] + + @labelfont.setter + def labelfont(self, val): + self["labelfont"] = val + + @property + def labelformat(self): + """ + Sets the contour label formatting rule using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'labelformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelformat"] + + @labelformat.setter + def labelformat(self, val): + self["labelformat"] = val + + @property + def operation(self): + """ + Sets the constraint operation. "=" keeps regions equal to + `value` "<" and "<=" keep regions less than `value` ">" and + ">=" keep regions greater than `value` "[]", "()", "[)", and + "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", + "](", ")[" keep regions outside `value[0]` to value[1]` Open + vs. closed intervals make no difference to constraint display, + but all versions are allowed for consistency with filter + transforms. + + The 'operation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] + + Returns + ------- + Any + """ + return self["operation"] + + @operation.setter + def operation(self, val): + self["operation"] = val + + @property + def showlabels(self): + """ + Determines whether to label the contour lines with their + values. + + The 'showlabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlabels"] + + @showlabels.setter + def showlabels(self, val): + self["showlabels"] = val + + @property + def showlines(self): + """ + Determines whether or not the contour lines are drawn. Has an + effect only if `contours.coloring` is set to "fill". + + The 'showlines' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlines"] + + @showlines.setter + def showlines(self, val): + self["showlines"] = val + + @property + def size(self): + """ + Sets the step between each contour level. Must be positive. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting contour level value. Must be less than + `contours.end` + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def type(self): + """ + If `levels`, the data is represented as a contour plot with + multiple levels displayed. If `constraint`, the data is + represented as constraints with the invalid region shaded as + specified by the `operation` and `value` parameters. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['levels', 'constraint'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value or values of the constraint boundary. When + `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of + two numbers where the first is the lower bound and the second + is the upper bound. + + The 'value' property accepts values of any type + + Returns + ------- + Any + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "lines", coloring is done on the + contour lines. If "none", no coloring is applied on + this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + """ + + def __init__( + self, + arg=None, + coloring=None, + end=None, + labelfont=None, + labelformat=None, + operation=None, + showlabels=None, + showlines=None, + size=None, + start=None, + type=None, + value=None, + **kwargs, + ): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contourcarpet.Contours` + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "lines", coloring is done on the + contour lines. If "none", no coloring is applied on + this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + + Returns + ------- + Contours + """ + super().__init__("contours") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.Contours +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.Contours`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("coloring", arg, coloring) + self._set_property("end", arg, end) + self._set_property("labelfont", arg, labelfont) + self._set_property("labelformat", arg, labelformat) + self._set_property("operation", arg, operation) + self._set_property("showlabels", arg, showlabels) + self._set_property("showlines", arg, showlines) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_legendgrouptitle.py new file mode 100644 index 0000000..77cc45a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet" + _path_str = "contourcarpet.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contourcarpet. + Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_line.py new file mode 100644 index 0000000..7846e68 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_line.py @@ -0,0 +1,176 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet" + _path_str = "contourcarpet.line" + _valid_props = {"color", "dash", "smoothing", "width"} + + @property + def color(self): + """ + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def smoothing(self): + """ + Sets the amount of smoothing for the contour lines, where 0 + corresponds to no smoothing. + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the contour line width in (in px) Defaults to 0.5 when + `contours.type` is "levels". Defaults to 2 when `contour.type` + is "constraint". + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the contour line width in (in px) Defaults to 0.5 + when `contours.type` is "levels". Defaults to 2 when + `contour.type` is "constraint". + """ + + def __init__( + self, arg=None, color=None, dash=None, smoothing=None, width=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contourcarpet.Line` + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the contour line width in (in px) Defaults to 0.5 + when `contours.type` is "levels". Defaults to 2 when + `contour.type` is "constraint". + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_stream.py new file mode 100644 index 0000000..cc8c3f7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet" + _path_str = "contourcarpet.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contourcarpet.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py new file mode 100644 index 0000000..184293e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet.colorbar" + _path_str = "contourcarpet.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contourcarpet. + colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py new file mode 100644 index 0000000..e62f409 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet.colorbar" + _path_str = "contourcarpet.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contourcarpet. + colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_title.py new file mode 100644 index 0000000..879af1d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet.colorbar" + _path_str = "contourcarpet.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.contourcarpet.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.contourcarpet.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.contourcarpet.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/_font.py new file mode 100644 index 0000000..673f011 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet.colorbar.title" + _path_str = "contourcarpet.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contourcarpet. + colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/__init__.py new file mode 100644 index 0000000..48d6bb6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._labelfont import Labelfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._labelfont.Labelfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/_labelfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/_labelfont.py new file mode 100644 index 0000000..d880ceb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/contours/_labelfont.py @@ -0,0 +1,336 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet.contours" + _path_str = "contourcarpet.contours.labelfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Labelfont object + + Sets the font used for labeling the contour levels. The default + color comes from the lines, if shown. The default family and + size come from `layout.font`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contourcarpet. + contours.Labelfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Labelfont + """ + super().__init__("labelfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.contours.Labelfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.contours.Labelfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/_font.py new file mode 100644 index 0000000..cf6e131 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/contourcarpet/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "contourcarpet.legendgrouptitle" + _path_str = "contourcarpet.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.contourcarpet. + legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.contourcarpet.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.contourcarpet.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/__init__.py new file mode 100644 index 0000000..7740f6e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/__init__.py @@ -0,0 +1,24 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._stream import Stream + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_colorbar.py new file mode 100644 index 0000000..750416e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_colorbar.py @@ -0,0 +1,1721 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "densitymap" + _path_str = "densitymap.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.densitymap.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.densitymap.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.densitymap.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.densitymap.col + orbar.tickformatstopdefaults), sets the default property values + to use for elements of densitymap.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.densitymap.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.densitymap.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.densitymap.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.densit + ymap.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + densitymap.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.densitymap.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.densitymap.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.densit + ymap.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + densitymap.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.densitymap.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_hoverlabel.py new file mode 100644 index 0000000..af9edb0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "densitymap" + _path_str = "densitymap.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.densitymap.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_legendgrouptitle.py new file mode 100644 index 0000000..27e91ac --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "densitymap" + _path_str = "densitymap.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.densitymap.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_stream.py new file mode 100644 index 0000000..d46b641 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "densitymap" + _path_str = "densitymap.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickfont.py new file mode 100644 index 0000000..26b4695 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "densitymap.colorbar" + _path_str = "densitymap.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py new file mode 100644 index 0000000..ec189ab --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "densitymap.colorbar" + _path_str = "densitymap.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymap.col + orbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_title.py new file mode 100644 index 0000000..caf12d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "densitymap.colorbar" + _path_str = "densitymap.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymap.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.densitymap.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/_font.py new file mode 100644 index 0000000..903a546 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "densitymap.colorbar.title" + _path_str = "densitymap.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymap.col + orbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/_font.py new file mode 100644 index 0000000..6ce6808 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "densitymap.hoverlabel" + _path_str = "densitymap.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymap.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/_font.py new file mode 100644 index 0000000..3aed80b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymap/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "densitymap.legendgrouptitle" + _path_str = "densitymap.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymap.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymap.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymap.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/__init__.py new file mode 100644 index 0000000..7740f6e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/__init__.py @@ -0,0 +1,24 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._stream import Stream + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_colorbar.py new file mode 100644 index 0000000..a6c1f87 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox" + _path_str = "densitymapbox.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.densitymapbox.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.densitymapbox.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.densitymapbox. + colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + densitymapbox.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.densitymapbox.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.densit + ymapbox.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + densitymapbox.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.densitymapbox.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymapbox.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.densitymapbox.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.densit + ymapbox.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + densitymapbox.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.densitymapbox.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_hoverlabel.py new file mode 100644 index 0000000..832e326 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox" + _path_str = "densitymapbox.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymapbox.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_legendgrouptitle.py new file mode 100644 index 0000000..79528e3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox" + _path_str = "densitymapbox.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymapbox. + Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_stream.py new file mode 100644 index 0000000..9949ce7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox" + _path_str = "densitymapbox.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymapbox.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py new file mode 100644 index 0000000..046dc4f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox.colorbar" + _path_str = "densitymapbox.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymapbox. + colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py new file mode 100644 index 0000000..e81db35 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox.colorbar" + _path_str = "densitymapbox.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymapbox. + colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_title.py new file mode 100644 index 0000000..b281eb6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox.colorbar" + _path_str = "densitymapbox.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.densitymapbox.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.densitymapbox.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.densitymapbox.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/_font.py new file mode 100644 index 0000000..f3d719e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox.colorbar.title" + _path_str = "densitymapbox.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymapbox. + colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/_font.py new file mode 100644 index 0000000..84548e8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox.hoverlabel" + _path_str = "densitymapbox.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymapbox. + hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/_font.py new file mode 100644 index 0000000..70b46b7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/densitymapbox/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "densitymapbox.legendgrouptitle" + _path_str = "densitymapbox.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.densitymapbox. + legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.densitymapbox.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.densitymapbox.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/__init__.py new file mode 100644 index 0000000..e488b00 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/__init__.py @@ -0,0 +1,33 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._connector import Connector + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._stream import Stream + from ._textfont import Textfont + from . import connector + from . import hoverlabel + from . import legendgrouptitle + from . import marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".connector", ".hoverlabel", ".legendgrouptitle", ".marker"], + [ + "._connector.Connector", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._stream.Stream", + "._textfont.Textfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_connector.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_connector.py new file mode 100644 index 0000000..c19f431 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_connector.py @@ -0,0 +1,130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Connector(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.connector" + _valid_props = {"fillcolor", "line", "visible"} + + @property + def fillcolor(self): + """ + Sets the fill color. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.connector.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.funnel.connector.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def visible(self): + """ + Determines if connector regions and lines are drawn. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the fill color. + line + :class:`plotly.graph_objects.funnel.connector.Line` + instance or dict with compatible properties + visible + Determines if connector regions and lines are drawn. + """ + + def __init__(self, arg=None, fillcolor=None, line=None, visible=None, **kwargs): + """ + Construct a new Connector object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.Connector` + fillcolor + Sets the fill color. + line + :class:`plotly.graph_objects.funnel.connector.Line` + instance or dict with compatible properties + visible + Determines if connector regions and lines are drawn. + + Returns + ------- + Connector + """ + super().__init__("connector") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Connector +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Connector`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fillcolor", arg, fillcolor) + self._set_property("line", arg, line) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_hoverlabel.py new file mode 100644 index 0000000..ad98b30 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.funnel.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_insidetextfont.py new file mode 100644 index 0000000..1ab68aa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `text` lying inside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_legendgrouptitle.py new file mode 100644 index 0000000..599ae79 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.funnel.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_marker.py new file mode 100644 index 0000000..631cc28 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_marker.py @@ -0,0 +1,621 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "line", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to funnel.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.funnel.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.funnel.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the bars. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.funnel.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.funnel.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.funnel.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.funnel.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.funnel.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_outsidetextfont.py new file mode 100644 index 0000000..a413cf4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_outsidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `text` lying outside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_stream.py new file mode 100644 index 0000000..a9b62ad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.funnel.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_textfont.py new file mode 100644 index 0000000..c7f91d3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "funnel" + _path_str = "funnel.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `text`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/_line.py new file mode 100644 index 0000000..9484bb3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/connector/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "funnel.connector" + _path_str = "funnel.connector.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.connector.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.connector.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.connector.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/_font.py new file mode 100644 index 0000000..fda3253 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "funnel.hoverlabel" + _path_str = "funnel.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/_font.py new file mode 100644 index 0000000..de2957b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "funnel.legendgrouptitle" + _path_str = "funnel.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/__init__.py new file mode 100644 index 0000000..e0fbf0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_colorbar.py new file mode 100644 index 0000000..9db280e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "funnel.marker" + _path_str = "funnel.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.funnel.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.funnel.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.funnel.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.funnel.marker. + colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + funnel.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.funnel.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.funnel.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.funnel.marker.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.funnel + .marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + funnel.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.funnel.marker.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.funnel.marker.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.funnel + .marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + funnel.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.funnel.marker.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_line.py new file mode 100644 index 0000000..3131fba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "funnel.marker" + _path_str = "funnel.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to funnel.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..57aa294 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "funnel.marker.colorbar" + _path_str = "funnel.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.funnel.marker. + colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..65a1693 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "funnel.marker.colorbar" + _path_str = "funnel.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.funnel.marker. + colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_title.py new file mode 100644 index 0000000..0b75fba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "funnel.marker.colorbar" + _path_str = "funnel.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnel.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.funnel.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnel.marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/_font.py new file mode 100644 index 0000000..b107d09 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnel/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "funnel.marker.colorbar.title" + _path_str = "funnel.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.funnel.marker. + colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnel.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnel.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/__init__.py new file mode 100644 index 0000000..639ccf4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/__init__.py @@ -0,0 +1,33 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._stream import Stream + from ._textfont import Textfont + from ._title import Title + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".title"], + [ + "._domain.Domain", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._stream.Stream", + "._textfont.Textfont", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_domain.py new file mode 100644 index 0000000..e83dc2d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this funnelarea trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this funnelarea trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this funnelarea trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this funnelarea trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this funnelarea trace . + row + If there is a layout grid, use the domain for this row + in the grid for this funnelarea trace . + x + Sets the horizontal domain of this funnelarea trace (in + plot fraction). + y + Sets the vertical domain of this funnelarea trace (in + plot fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this funnelarea trace . + row + If there is a layout grid, use the domain for this row + in the grid for this funnelarea trace . + x + Sets the horizontal domain of this funnelarea trace (in + plot fraction). + y + Sets the vertical domain of this funnelarea trace (in + plot fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_hoverlabel.py new file mode 100644 index 0000000..0285bce --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.funnelarea.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_insidetextfont.py new file mode 100644 index 0000000..0aa7f8f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `textinfo` lying inside the sector. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_legendgrouptitle.py new file mode 100644 index 0000000..3efd6da --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.funnelarea.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_marker.py new file mode 100644 index 0000000..ca38cf7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_marker.py @@ -0,0 +1,161 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.marker" + _valid_props = {"colors", "colorssrc", "line", "pattern"} + + @property + def colors(self): + """ + Sets the color of each sector. If not specified, the default + trace color set is used to pick the sector colors. + + The 'colors' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["colors"] + + @colors.setter + def colors(self, val): + self["colors"] = val + + @property + def colorssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `colors`. + + The 'colorssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorssrc"] + + @colorssrc.setter + def colorssrc(self, val): + self["colorssrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.funnelarea.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.funnelarea.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def _prop_descriptions(self): + return """\ + colors + Sets the color of each sector. If not specified, the + default trace color set is used to pick the sector + colors. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.funnelarea.marker.Line` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + """ + + def __init__( + self, arg=None, colors=None, colorssrc=None, line=None, pattern=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Marker` + colors + Sets the color of each sector. If not specified, the + default trace color set is used to pick the sector + colors. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.funnelarea.marker.Line` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("colors", arg, colors) + self._set_property("colorssrc", arg, colorssrc) + self._set_property("line", arg, line) + self._set_property("pattern", arg, pattern) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_stream.py new file mode 100644 index 0000000..c271022 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_textfont.py new file mode 100644 index 0000000..7b61d33 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `textinfo`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_title.py new file mode 100644 index 0000000..5c2d042 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/_title.py @@ -0,0 +1,131 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea" + _path_str = "funnelarea.title" + _valid_props = {"font", "position", "text"} + + @property + def font(self): + """ + Sets the font used for `title`. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.funnelarea.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.funnelarea.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def position(self): + """ + Specifies the location of the `title`. + + The 'position' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right'] + + Returns + ------- + Any + """ + return self["position"] + + @position.setter + def position(self, val): + self["position"] = val + + @property + def text(self): + """ + Sets the title of the chart. If it is empty, no title is + displayed. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets the font used for `title`. + position + Specifies the location of the `title`. + text + Sets the title of the chart. If it is empty, no title + is displayed. + """ + + def __init__(self, arg=None, font=None, position=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.Title` + font + Sets the font used for `title`. + position + Specifies the location of the `title`. + text + Sets the title of the chart. If it is empty, no title + is displayed. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("position", arg, position) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/_font.py new file mode 100644 index 0000000..63dcb4f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea.hoverlabel" + _path_str = "funnelarea.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/_font.py new file mode 100644 index 0000000..5b01415 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea.legendgrouptitle" + _path_str = "funnelarea.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.funnelarea.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/__init__.py new file mode 100644 index 0000000..ae09590 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line + from ._pattern import Pattern +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._line.Line", "._pattern.Pattern"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_line.py new file mode 100644 index 0000000..a8d25f0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_line.py @@ -0,0 +1,163 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea.marker" + _path_str = "funnelarea.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. Defaults to + the `paper_bgcolor` value. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.marker.Line` + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_pattern.py new file mode 100644 index 0000000..99e8420 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea.marker" + _path_str = "funnelarea.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/_font.py new file mode 100644 index 0000000..0b90b88 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/funnelarea/title/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "funnelarea.title" + _path_str = "funnelarea.title.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used for `title`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.funnelarea.title.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.funnelarea.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.funnelarea.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/graph_objs.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/graph_objs.py new file mode 100644 index 0000000..60189f9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/graph_objs.py @@ -0,0 +1 @@ +from plotly.graph_objs import * diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/__init__.py new file mode 100644 index 0000000..4ae9809 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/__init__.py @@ -0,0 +1,26 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._stream import Stream + from ._textfont import Textfont + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._stream.Stream", + "._textfont.Textfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_colorbar.py new file mode 100644 index 0000000..c75db38 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "heatmap" + _path_str = "heatmap.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.heatmap.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.heatmap.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.heatmap.colorbar.tickformatstopdefaults), + sets the default property values to use for elements of + heatmap.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.heatmap.colorba + r.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.heatma + p.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + heatmap.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.heatmap.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.heatmap.colorba + r.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.heatma + p.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + heatmap.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.heatmap.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_hoverlabel.py new file mode 100644 index 0000000..03a7a2e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "heatmap" + _path_str = "heatmap.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.heatmap.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_legendgrouptitle.py new file mode 100644 index 0000000..b3f935a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "heatmap" + _path_str = "heatmap.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.heatmap.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_stream.py new file mode 100644 index 0000000..776d1b3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "heatmap" + _path_str = "heatmap.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_textfont.py new file mode 100644 index 0000000..b09281c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/_textfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "heatmap" + _path_str = "heatmap.textfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickfont.py new file mode 100644 index 0000000..807c1e2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "heatmap.colorbar" + _path_str = "heatmap.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py new file mode 100644 index 0000000..3055e07 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "heatmap.colorbar" + _path_str = "heatmap.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.heatmap.colorb + ar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_title.py new file mode 100644 index 0000000..f362767 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "heatmap.colorbar" + _path_str = "heatmap.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.heatmap.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.heatmap.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/_font.py new file mode 100644 index 0000000..cd5653f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "heatmap.colorbar.title" + _path_str = "heatmap.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/_font.py new file mode 100644 index 0000000..7885449 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "heatmap.hoverlabel" + _path_str = "heatmap.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.heatmap.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/_font.py new file mode 100644 index 0000000..681209c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/heatmap/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "heatmap.legendgrouptitle" + _path_str = "heatmap.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.heatmap.legend + grouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.heatmap.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.heatmap.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/__init__.py new file mode 100644 index 0000000..ba70e4a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/__init__.py @@ -0,0 +1,46 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._cumulative import Cumulative + from ._error_x import ErrorX + from ._error_y import ErrorY + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from ._xbins import XBins + from ._ybins import YBins + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._cumulative.Cumulative", + "._error_x.ErrorX", + "._error_y.ErrorY", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + "._xbins.XBins", + "._ybins.YBins", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_cumulative.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_cumulative.py new file mode 100644 index 0000000..0799480 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_cumulative.py @@ -0,0 +1,173 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Cumulative(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.cumulative" + _valid_props = {"currentbin", "direction", "enabled"} + + @property + def currentbin(self): + """ + Only applies if cumulative is enabled. Sets whether the current + bin is included, excluded, or has half of its value included in + the current cumulative value. "include" is the default for + compatibility with various other tools, however it introduces a + half-bin bias to the results. "exclude" makes the opposite + half-bin bias, and "half" removes it. + + The 'currentbin' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['include', 'exclude', 'half'] + + Returns + ------- + Any + """ + return self["currentbin"] + + @currentbin.setter + def currentbin(self, val): + self["currentbin"] = val + + @property + def direction(self): + """ + Only applies if cumulative is enabled. If "increasing" + (default) we sum all prior bins, so the result increases from + left to right. If "decreasing" we sum later bins so the result + decreases from left to right. + + The 'direction' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['increasing', 'decreasing'] + + Returns + ------- + Any + """ + return self["direction"] + + @direction.setter + def direction(self, val): + self["direction"] = val + + @property + def enabled(self): + """ + If true, display the cumulative distribution by summing the + binned values. Use the `direction` and `centralbin` attributes + to tune the accumulation method. Note: in this mode, the + "density" `histnorm` settings behave the same as their + equivalents without "density": "" and "density" both rise to + the number of data points, and "probability" and *probability + density* both rise to the number of sample points. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def _prop_descriptions(self): + return """\ + currentbin + Only applies if cumulative is enabled. Sets whether the + current bin is included, excluded, or has half of its + value included in the current cumulative value. + "include" is the default for compatibility with various + other tools, however it introduces a half-bin bias to + the results. "exclude" makes the opposite half-bin + bias, and "half" removes it. + direction + Only applies if cumulative is enabled. If "increasing" + (default) we sum all prior bins, so the result + increases from left to right. If "decreasing" we sum + later bins so the result decreases from left to right. + enabled + If true, display the cumulative distribution by summing + the binned values. Use the `direction` and `centralbin` + attributes to tune the accumulation method. Note: in + this mode, the "density" `histnorm` settings behave the + same as their equivalents without "density": "" and + "density" both rise to the number of data points, and + "probability" and *probability density* both rise to + the number of sample points. + """ + + def __init__( + self, arg=None, currentbin=None, direction=None, enabled=None, **kwargs + ): + """ + Construct a new Cumulative object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Cumulative` + currentbin + Only applies if cumulative is enabled. Sets whether the + current bin is included, excluded, or has half of its + value included in the current cumulative value. + "include" is the default for compatibility with various + other tools, however it introduces a half-bin bias to + the results. "exclude" makes the opposite half-bin + bias, and "half" removes it. + direction + Only applies if cumulative is enabled. If "increasing" + (default) we sum all prior bins, so the result + increases from left to right. If "decreasing" we sum + later bins so the result decreases from left to right. + enabled + If true, display the cumulative distribution by summing + the binned values. Use the `direction` and `centralbin` + attributes to tune the accumulation method. Note: in + this mode, the "density" `histnorm` settings behave the + same as their equivalents without "density": "" and + "density" both rise to the number of data points, and + "probability" and *probability density* both rise to + the number of sample points. + + Returns + ------- + Cumulative + """ + super().__init__("cumulative") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Cumulative +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Cumulative`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("currentbin", arg, currentbin) + self._set_property("direction", arg, direction) + self._set_property("enabled", arg, enabled) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_x.py new file mode 100644 index 0000000..0f51b63 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_x.py @@ -0,0 +1,503 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.error_x" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "copy_ystyle", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["copy_ystyle"] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self["copy_ystyle"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.ErrorX` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super().__init__("error_x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.ErrorX +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.ErrorX`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("copy_ystyle", arg, copy_ystyle) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_y.py new file mode 100644 index 0000000..9c33cf1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_error_y.py @@ -0,0 +1,480 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.error_y" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.ErrorY` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super().__init__("error_y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.ErrorY +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.ErrorY`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_hoverlabel.py new file mode 100644 index 0000000..f9761b9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_insidetextfont.py new file mode 100644 index 0000000..f7d9c83 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_insidetextfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.insidetextfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `text` lying inside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Insidetextfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_legendgrouptitle.py new file mode 100644 index 0000000..aea72de --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_marker.py new file mode 100644 index 0000000..4606fa6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_marker.py @@ -0,0 +1,686 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "cornerradius", + "line", + "opacity", + "opacitysrc", + "pattern", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to histogram.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def cornerradius(self): + """ + Sets the rounding of corners. May be an integer number of + pixels, or a percentage of bar width (as a string ending in %). + Defaults to `layout.barcornerradius`. In stack or relative + barmode, the first trace to set cornerradius is used for the + whole stack. + + The 'cornerradius' property accepts values of any type + + Returns + ------- + Any + """ + return self["cornerradius"] + + @cornerradius.setter + def cornerradius(self, val): + self["cornerradius"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the opacity of the bars. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + cornerradius + Sets the rounding of corners. May be an integer number + of pixels, or a percentage of bar width (as a string + ending in %). Defaults to `layout.barcornerradius`. In + stack or relative barmode, the first trace to set + cornerradius is used for the whole stack. + line + :class:`plotly.graph_objects.histogram.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + cornerradius=None, + line=None, + opacity=None, + opacitysrc=None, + pattern=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.histogram.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + cornerradius + Sets the rounding of corners. May be an integer number + of pixels, or a percentage of bar width (as a string + ending in %). Defaults to `layout.barcornerradius`. In + stack or relative barmode, the first trace to set + cornerradius is used for the whole stack. + line + :class:`plotly.graph_objects.histogram.marker.Line` + instance or dict with compatible properties + opacity + Sets the opacity of the bars. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("cornerradius", arg, cornerradius) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("pattern", arg, pattern) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_outsidetextfont.py new file mode 100644 index 0000000..ae088ec --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_outsidetextfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.outsidetextfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `text` lying outside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Outsidetextfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_selected.py new file mode 100644 index 0000000..b99df32 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.histogram.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.histogram.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.histogram.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.histogram.selected.Textfon + t` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Selected` + marker + :class:`plotly.graph_objects.histogram.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.histogram.selected.Textfon + t` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_stream.py new file mode 100644 index 0000000..1249bc9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_textfont.py new file mode 100644 index 0000000..dcacc29 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_textfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.textfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_unselected.py new file mode 100644 index 0000000..a9e9341 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.histogram.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.histogram.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.histogram.unselected.Marke + r` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.histogram.unselected.Textf + ont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.Unselected` + marker + :class:`plotly.graph_objects.histogram.unselected.Marke + r` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.histogram.unselected.Textf + ont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_xbins.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_xbins.py new file mode 100644 index 0000000..a0dd1a5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_xbins.py @@ -0,0 +1,210 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class XBins(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.xbins" + _valid_props = {"end", "size", "start"} + + @property + def end(self): + """ + Sets the end value for the x axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def size(self): + """ + Sets the size of each x axis bin. Default behavior: If `nbinsx` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsx` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). If multiple non-overlaying + histograms share a subplot, the first explicit `size` is used + and all others discarded. If no `size` is provided,the sample + data from all traces is combined to determine `size` as + described above. + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting value for the x axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non-overlaying + histograms share a subplot, the first explicit `start` is used + exactly and all others are shifted down (if necessary) to + differ from that one by an integer number of bins. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new XBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.XBins` + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + + Returns + ------- + XBins + """ + super().__init__("xbins") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.XBins +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.XBins`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("end", arg, end) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_ybins.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_ybins.py new file mode 100644 index 0000000..1c0975d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/_ybins.py @@ -0,0 +1,210 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class YBins(_BaseTraceHierarchyType): + _parent_path_str = "histogram" + _path_str = "histogram.ybins" + _valid_props = {"end", "size", "start"} + + @property + def end(self): + """ + Sets the end value for the y axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def size(self): + """ + Sets the size of each y axis bin. Default behavior: If `nbinsy` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsy` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). If multiple non-overlaying + histograms share a subplot, the first explicit `size` is used + and all others discarded. If no `size` is provided,the sample + data from all traces is combined to determine `size` as + described above. + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting value for the y axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. If multiple non-overlaying + histograms share a subplot, the first explicit `start` is used + exactly and all others are shifted down (if necessary) to + differ from that one by an integer number of bins. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new YBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.YBins` + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). If multiple non- + overlaying histograms share a subplot, the first + explicit `size` is used and all others discarded. If no + `size` is provided,the sample data from all traces is + combined to determine `size` as described above. + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. If + multiple non-overlaying histograms share a subplot, the + first explicit `start` is used exactly and all others + are shifted down (if necessary) to differ from that one + by an integer number of bins. + + Returns + ------- + YBins + """ + super().__init__("ybins") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.YBins +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.YBins`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("end", arg, end) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/_font.py new file mode 100644 index 0000000..0e6c08b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram.hoverlabel" + _path_str = "histogram.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/_font.py new file mode 100644 index 0000000..20e0452 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram.legendgrouptitle" + _path_str = "histogram.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram.lege + ndgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/__init__.py new file mode 100644 index 0000000..e2d7a12 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from ._pattern import Pattern + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_colorbar.py new file mode 100644 index 0000000..80eba66 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker" + _path_str = "histogram.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.histogram.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.histogram.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.histogram.mark + er.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + histogram.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.histogram.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.histogram.marker.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.histogram.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.histogram.marker.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_line.py new file mode 100644 index 0000000..d236c0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker" + _path_str = "histogram.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to histogram.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_pattern.py new file mode 100644 index 0000000..1b3673a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker" + _path_str = "histogram.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..8d282ee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker.colorbar" + _path_str = "histogram.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..b3fda12 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker.colorbar" + _path_str = "histogram.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_title.py new file mode 100644 index 0000000..f7b5a88 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker.colorbar" + _path_str = "histogram.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/_font.py new file mode 100644 index 0000000..aaa57f4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram.marker.colorbar.title" + _path_str = "histogram.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram.mark + er.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_marker.py new file mode 100644 index 0000000..7858b6f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_marker.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "histogram.selected" + _path_str = "histogram.selected.marker" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_textfont.py new file mode 100644 index 0000000..dc0739a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram.selected" + _path_str = "histogram.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_marker.py new file mode 100644 index 0000000..1912438 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_marker.py @@ -0,0 +1,110 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "histogram.unselected" + _path_str = "histogram.unselected.marker" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_textfont.py new file mode 100644 index 0000000..423fc3d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram.unselected" + _path_str = "histogram.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram.unse + lected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/__init__.py new file mode 100644 index 0000000..780e8d1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/__init__.py @@ -0,0 +1,32 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._stream import Stream + from ._textfont import Textfont + from ._xbins import XBins + from ._ybins import YBins + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._stream.Stream", + "._textfont.Textfont", + "._xbins.XBins", + "._ybins.YBins", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_colorbar.py new file mode 100644 index 0000000..f8b9298 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.histogram2d.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.histogram2d.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.histogram2d.co + lorbar.tickformatstopdefaults), sets the default property + values to use for elements of + histogram2d.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.histogram2d.col + orbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2d.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2d.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.histogram2d.colorbar.Title + ` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.histogram2d.col + orbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2d.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2d.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.histogram2d.colorbar.Title + ` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_hoverlabel.py new file mode 100644 index 0000000..6c4513c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram2d.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_legendgrouptitle.py new file mode 100644 index 0000000..8e993cd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram2d.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_marker.py new file mode 100644 index 0000000..c433bac --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_marker.py @@ -0,0 +1,102 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.marker" + _valid_props = {"color", "colorsrc"} + + @property + def color(self): + """ + Sets the aggregation data. + + The 'color' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the aggregation data. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.Marker` + color + Sets the aggregation data. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_stream.py new file mode 100644 index 0000000..7d45c68 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_textfont.py new file mode 100644 index 0000000..047d5b0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_textfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.textfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_xbins.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_xbins.py new file mode 100644 index 0000000..076c78d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_xbins.py @@ -0,0 +1,187 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class XBins(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.xbins" + _valid_props = {"end", "size", "start"} + + @property + def end(self): + """ + Sets the end value for the x axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def size(self): + """ + Sets the size of each x axis bin. Default behavior: If `nbinsx` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsx` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting value for the x axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new XBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.XBins` + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + XBins + """ + super().__init__("xbins") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.XBins +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.XBins`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("end", arg, end) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_ybins.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_ybins.py new file mode 100644 index 0000000..c24581d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/_ybins.py @@ -0,0 +1,187 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class YBins(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d" + _path_str = "histogram2d.ybins" + _valid_props = {"end", "size", "start"} + + @property + def end(self): + """ + Sets the end value for the y axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def size(self): + """ + Sets the size of each y axis bin. Default behavior: If `nbinsy` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsy` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting value for the y axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new YBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.YBins` + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + YBins + """ + super().__init__("ybins") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.YBins +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.YBins`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("end", arg, end) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickfont.py new file mode 100644 index 0000000..5e74d76 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d.colorbar" + _path_str = "histogram2d.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2d.co + lorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py new file mode 100644 index 0000000..b6cf996 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d.colorbar" + _path_str = "histogram2d.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2d.co + lorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_title.py new file mode 100644 index 0000000..a941eb6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d.colorbar" + _path_str = "histogram2d.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2d.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram2d.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/_font.py new file mode 100644 index 0000000..2e0dd20 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d.colorbar.title" + _path_str = "histogram2d.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2d.co + lorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/_font.py new file mode 100644 index 0000000..0aded40 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d.hoverlabel" + _path_str = "histogram2d.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2d.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/_font.py new file mode 100644 index 0000000..e1eda69 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2d/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram2d.legendgrouptitle" + _path_str = "histogram2d.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2d.le + gendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2d.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2d.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/__init__.py new file mode 100644 index 0000000..406ff71 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/__init__.py @@ -0,0 +1,37 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._contours import Contours + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._stream import Stream + from ._textfont import Textfont + from ._xbins import XBins + from ._ybins import YBins + from . import colorbar + from . import contours + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".contours", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._contours.Contours", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._stream.Stream", + "._textfont.Textfont", + "._xbins.XBins", + "._ybins.YBins", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_colorbar.py new file mode 100644 index 0000000..0fe4f0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.histogram2dcon + tour.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + histogram2dcontour.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.histogram2dcont + our.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2dcontour.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2dcontour.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.histogram2dcontour.colorba + r.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.histogram2dcont + our.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.histog + ram2dcontour.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + histogram2dcontour.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.histogram2dcontour.colorba + r.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_contours.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_contours.py new file mode 100644 index 0000000..fd0c374 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_contours.py @@ -0,0 +1,436 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.contours" + _valid_props = { + "coloring", + "end", + "labelfont", + "labelformat", + "operation", + "showlabels", + "showlines", + "size", + "start", + "type", + "value", + } + + @property + def coloring(self): + """ + Determines the coloring method showing the contour values. If + "fill", coloring is done evenly between each contour level If + "heatmap", a heatmap gradient coloring is applied between each + contour level. If "lines", coloring is done on the contour + lines. If "none", no coloring is applied on this trace. + + The 'coloring' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'heatmap', 'lines', 'none'] + + Returns + ------- + Any + """ + return self["coloring"] + + @coloring.setter + def coloring(self, val): + self["coloring"] = val + + @property + def end(self): + """ + Sets the end contour level value. Must be more than + `contours.start` + + The 'end' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def labelfont(self): + """ + Sets the font used for labeling the contour levels. The default + color comes from the lines, if shown. The default family and + size come from `layout.font`. + + The 'labelfont' property is an instance of Labelfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.contours.Labelfont` + - A dict of string/value properties that will be passed + to the Labelfont constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.contours.Labelfont + """ + return self["labelfont"] + + @labelfont.setter + def labelfont(self, val): + self["labelfont"] = val + + @property + def labelformat(self): + """ + Sets the contour label formatting rule using d3 formatting + mini-languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'labelformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["labelformat"] + + @labelformat.setter + def labelformat(self, val): + self["labelformat"] = val + + @property + def operation(self): + """ + Sets the constraint operation. "=" keeps regions equal to + `value` "<" and "<=" keep regions less than `value` ">" and + ">=" keep regions greater than `value` "[]", "()", "[)", and + "(]" keep regions inside `value[0]` to `value[1]` "][", ")(", + "](", ")[" keep regions outside `value[0]` to value[1]` Open + vs. closed intervals make no difference to constraint display, + but all versions are allowed for consistency with filter + transforms. + + The 'operation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['=', '<', '>=', '>', '<=', '[]', '()', '[)', '(]', '][', + ')(', '](', ')['] + + Returns + ------- + Any + """ + return self["operation"] + + @operation.setter + def operation(self, val): + self["operation"] = val + + @property + def showlabels(self): + """ + Determines whether to label the contour lines with their + values. + + The 'showlabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlabels"] + + @showlabels.setter + def showlabels(self, val): + self["showlabels"] = val + + @property + def showlines(self): + """ + Determines whether or not the contour lines are drawn. Has an + effect only if `contours.coloring` is set to "fill". + + The 'showlines' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlines"] + + @showlines.setter + def showlines(self, val): + self["showlines"] = val + + @property + def size(self): + """ + Sets the step between each contour level. Must be positive. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting contour level value. Must be less than + `contours.end` + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def type(self): + """ + If `levels`, the data is represented as a contour plot with + multiple levels displayed. If `constraint`, the data is + represented as constraints with the invalid region shaded as + specified by the `operation` and `value` parameters. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['levels', 'constraint'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value or values of the constraint boundary. When + `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an array of + two numbers where the first is the lower bound and the second + is the upper bound. + + The 'value' property accepts values of any type + + Returns + ------- + Any + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + """ + + def __init__( + self, + arg=None, + coloring=None, + end=None, + labelfont=None, + labelformat=None, + operation=None, + showlabels=None, + showlines=None, + size=None, + start=None, + type=None, + value=None, + **kwargs, + ): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.Contours` + coloring + Determines the coloring method showing the contour + values. If "fill", coloring is done evenly between each + contour level If "heatmap", a heatmap gradient coloring + is applied between each contour level. If "lines", + coloring is done on the contour lines. If "none", no + coloring is applied on this trace. + end + Sets the end contour level value. Must be more than + `contours.start` + labelfont + Sets the font used for labeling the contour levels. The + default color comes from the lines, if shown. The + default family and size come from `layout.font`. + labelformat + Sets the contour label formatting rule using d3 + formatting mini-languages which are very similar to + those in Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + operation + Sets the constraint operation. "=" keeps regions equal + to `value` "<" and "<=" keep regions less than `value` + ">" and ">=" keep regions greater than `value` "[]", + "()", "[)", and "(]" keep regions inside `value[0]` to + `value[1]` "][", ")(", "](", ")[" keep regions outside + `value[0]` to value[1]` Open vs. closed intervals make + no difference to constraint display, but all versions + are allowed for consistency with filter transforms. + showlabels + Determines whether to label the contour lines with + their values. + showlines + Determines whether or not the contour lines are drawn. + Has an effect only if `contours.coloring` is set to + "fill". + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + type + If `levels`, the data is represented as a contour plot + with multiple levels displayed. If `constraint`, the + data is represented as constraints with the invalid + region shaded as specified by the `operation` and + `value` parameters. + value + Sets the value or values of the constraint boundary. + When `operation` is set to one of the comparison values + (=,<,>=,>,<=) "value" is expected to be a number. When + `operation` is set to one of the interval values + ([],(),[),(],][,)(,](,)[) "value" is expected to be an + array of two numbers where the first is the lower bound + and the second is the upper bound. + + Returns + ------- + Contours + """ + super().__init__("contours") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Contours +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Contours`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("coloring", arg, coloring) + self._set_property("end", arg, end) + self._set_property("labelfont", arg, labelfont) + self._set_property("labelformat", arg, labelformat) + self._set_property("operation", arg, operation) + self._set_property("showlabels", arg, showlabels) + self._set_property("showlines", arg, showlines) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_hoverlabel.py new file mode 100644 index 0000000..b1cb457 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_legendgrouptitle.py new file mode 100644 index 0000000..b327560 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_line.py new file mode 100644 index 0000000..c57d618 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_line.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.line" + _valid_props = {"color", "dash", "smoothing", "width"} + + @property + def color(self): + """ + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def smoothing(self): + """ + Sets the amount of smoothing for the contour lines, where 0 + corresponds to no smoothing. + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the contour line width in (in px) + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the contour line width in (in px) + """ + + def __init__( + self, arg=None, color=None, dash=None, smoothing=None, width=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.Line` + color + Sets the color of the contour level. Has no effect if + `contours.coloring` is set to "lines". + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + smoothing + Sets the amount of smoothing for the contour lines, + where 0 corresponds to no smoothing. + width + Sets the contour line width in (in px) + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_marker.py new file mode 100644 index 0000000..146412a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_marker.py @@ -0,0 +1,102 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.marker" + _valid_props = {"color", "colorsrc"} + + @property + def color(self): + """ + Sets the aggregation data. + + The 'color' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the aggregation data. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.Marker` + color + Sets the aggregation data. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_stream.py new file mode 100644 index 0000000..59dbafd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_textfont.py new file mode 100644 index 0000000..36f7542 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_textfont.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.textfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + For this trace it only has an effect if `coloring` is set to + "heatmap". Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_xbins.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_xbins.py new file mode 100644 index 0000000..80a4aca --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_xbins.py @@ -0,0 +1,187 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class XBins(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.xbins" + _valid_props = {"end", "size", "start"} + + @property + def end(self): + """ + Sets the end value for the x axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def size(self): + """ + Sets the size of each x axis bin. Default behavior: If `nbinsx` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsx` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting value for the x axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new XBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.XBins` + end + Sets the end value for the x axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each x axis bin. Default behavior: If + `nbinsx` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsx` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the x axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + XBins + """ + super().__init__("xbins") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.XBins +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.XBins`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("end", arg, end) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_ybins.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_ybins.py new file mode 100644 index 0000000..f73dc70 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/_ybins.py @@ -0,0 +1,187 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class YBins(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour" + _path_str = "histogram2dcontour.ybins" + _valid_props = {"end", "size", "start"} + + @property + def end(self): + """ + Sets the end value for the y axis bins. The last bin may not + end exactly at this value, we increment the bin edge by `size` + from `start` until we reach or exceed `end`. Defaults to the + maximum data value. Like `start`, for dates use a date string, + and for category data `end` is based on the category serial + numbers. + + The 'end' property accepts values of any type + + Returns + ------- + Any + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def size(self): + """ + Sets the size of each y axis bin. Default behavior: If `nbinsy` + is 0 or omitted, we choose a nice round bin size such that the + number of bins is about the same as the typical number of + samples in each bin. If `nbinsy` is provided, we choose a nice + round bin size giving no more than that many bins. For date + data, use milliseconds or "M" for months, as in + `axis.dtick`. For category data, the number of categories to + bin together (always defaults to 1). + + The 'size' property accepts values of any type + + Returns + ------- + Any + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting value for the y axis bins. Defaults to the + minimum data value, shifted down if necessary to make nice + round values and to remove ambiguous bin edges. For example, if + most of the data is integers we shift the bin edges 0.5 down, + so a `size` of 5 would have a default `start` of -0.5, so it is + clear that 0-4 are in the first bin, 5-9 in the second, but + continuous data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date string. + For category data, `start` is based on the category serial + numbers, and defaults to -0.5. + + The 'start' property accepts values of any type + + Returns + ------- + Any + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def _prop_descriptions(self): + return """\ + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + """ + + def __init__(self, arg=None, end=None, size=None, start=None, **kwargs): + """ + Construct a new YBins object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.histogram2dcontour.YBins` + end + Sets the end value for the y axis bins. The last bin + may not end exactly at this value, we increment the bin + edge by `size` from `start` until we reach or exceed + `end`. Defaults to the maximum data value. Like + `start`, for dates use a date string, and for category + data `end` is based on the category serial numbers. + size + Sets the size of each y axis bin. Default behavior: If + `nbinsy` is 0 or omitted, we choose a nice round bin + size such that the number of bins is about the same as + the typical number of samples in each bin. If `nbinsy` + is provided, we choose a nice round bin size giving no + more than that many bins. For date data, use + milliseconds or "M" for months, as in `axis.dtick`. + For category data, the number of categories to bin + together (always defaults to 1). + start + Sets the starting value for the y axis bins. Defaults + to the minimum data value, shifted down if necessary to + make nice round values and to remove ambiguous bin + edges. For example, if most of the data is integers we + shift the bin edges 0.5 down, so a `size` of 5 would + have a default `start` of -0.5, so it is clear that 0-4 + are in the first bin, 5-9 in the second, but continuous + data gets a start of 0 and bins [0,5), [5,10) etc. + Dates behave similarly, and `start` should be a date + string. For category data, `start` is based on the + category serial numbers, and defaults to -0.5. + + Returns + ------- + YBins + """ + super().__init__("ybins") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.YBins +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.YBins`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("end", arg, end) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py new file mode 100644 index 0000000..164e6ba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.colorbar" + _path_str = "histogram2dcontour.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py new file mode 100644 index 0000000..1dba319 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.colorbar" + _path_str = "histogram2dcontour.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_title.py new file mode 100644 index 0000000..52f41a1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.colorbar" + _path_str = "histogram2dcontour.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.histogram2dcontour.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py new file mode 100644 index 0000000..8c9e818 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.colorbar.title" + _path_str = "histogram2dcontour.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/__init__.py new file mode 100644 index 0000000..48d6bb6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._labelfont import Labelfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._labelfont.Labelfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py new file mode 100644 index 0000000..96bc43b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/contours/_labelfont.py @@ -0,0 +1,336 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.contours" + _path_str = "histogram2dcontour.contours.labelfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Labelfont object + + Sets the font used for labeling the contour levels. The default + color comes from the lines, if shown. The default family and + size come from `layout.font`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.contours.Labelfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Labelfont + """ + super().__init__("labelfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.contours.Labelfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.contours.Labelfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py new file mode 100644 index 0000000..3697c6b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.hoverlabel" + _path_str = "histogram2dcontour.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/_font.py new file mode 100644 index 0000000..79fa0f4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/histogram2dcontour/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "histogram2dcontour.legendgrouptitle" + _path_str = "histogram2dcontour.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.histogram2dcon + tour.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.histogram2dcontour.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/__init__.py new file mode 100644 index 0000000..4450c0c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/__init__.py @@ -0,0 +1,41 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._leaf import Leaf + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._pathbar import Pathbar + from ._root import Root + from ._stream import Stream + from ._textfont import Textfont + from ._tiling import Tiling + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import pathbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".pathbar"], + [ + "._domain.Domain", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._leaf.Leaf", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._pathbar.Pathbar", + "._root.Root", + "._stream.Stream", + "._textfont.Textfont", + "._tiling.Tiling", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_domain.py new file mode 100644 index 0000000..82640ce --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_domain.py @@ -0,0 +1,169 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this icicle trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this icicle trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this icicle trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this icicle trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this icicle trace . + row + If there is a layout grid, use the domain for this row + in the grid for this icicle trace . + x + Sets the horizontal domain of this icicle trace (in + plot fraction). + y + Sets the vertical domain of this icicle trace (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this icicle trace . + row + If there is a layout grid, use the domain for this row + in the grid for this icicle trace . + x + Sets the horizontal domain of this icicle trace (in + plot fraction). + y + Sets the vertical domain of this icicle trace (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_hoverlabel.py new file mode 100644 index 0000000..1cf2d8e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.icicle.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_insidetextfont.py new file mode 100644 index 0000000..6be9851 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `textinfo` lying inside the sector. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_leaf.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_leaf.py new file mode 100644 index 0000000..467527d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_leaf.py @@ -0,0 +1,79 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Leaf(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.leaf" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the opacity of the leaves. With colorscale it is defaulted + to 1; otherwise it is defaulted to 0.7 + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the opacity of the leaves. With colorscale it is + defaulted to 1; otherwise it is defaulted to 0.7 + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Leaf object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.Leaf` + opacity + Sets the opacity of the leaves. With colorscale it is + defaulted to 1; otherwise it is defaulted to 0.7 + + Returns + ------- + Leaf + """ + super().__init__("leaf") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Leaf +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Leaf`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_legendgrouptitle.py new file mode 100644 index 0000000..11ed7f9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.icicle.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_marker.py new file mode 100644 index 0000000..15330a6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_marker.py @@ -0,0 +1,578 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colors", + "colorscale", + "colorssrc", + "line", + "pattern", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is set to a + numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here colors) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect only if colors is + set to a numerical array. Defaults to `false` when + `marker.cmin` and `marker.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + colors is set to a numerical array. Value should have the same + units as colors and if set, `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if colors is set to a numerical array. Value should + have the same units as colors. Has no effect when + `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + colors is set to a numerical array. Value should have the same + units as colors and if set, `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colors(self): + """ + Sets the color of each sector of this trace. If not specified, + the default trace color set is used to pick the sector colors. + + The 'colors' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["colors"] + + @colors.setter + def colors(self, val): + self["colors"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if colors is set to a + numerical array. 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `marker.cmin` and + `marker.cmax`. Alternatively, `colorscale` may be a palette + name string of the following list: Blackbody,Bluered,Blues,Civi + dis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow + ,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `colors`. + + The 'colorssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorssrc"] + + @colorssrc.setter + def colorssrc(self, val): + self["colorssrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if + colors is set to a numerical array. If true, `marker.cmin` will + correspond to the last color in the array and `marker.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if colors is set to a numerical + array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is + set to a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the default + palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or + mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here colors) or the + bounds set in `marker.cmin` and `marker.cmax` Has an + effect only if colors is set to a numerical array. + Defaults to `false` when `marker.cmin` and + `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if colors is set to a + numerical array. Value should have the same units as + colors. Has no effect when `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.icicle.marker.ColorBar` + instance or dict with compatible properties + colors + Sets the color of each sector of this trace. If not + specified, the default trace color set is used to pick + the sector colors. + colorscale + Sets the colorscale. Has an effect only if colors is + set to a numerical array. 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, `[[0, + 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.icicle.marker.Line` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if colors is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the + array and `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if colors is set to a + numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colors=None, + colorscale=None, + colorssrc=None, + line=None, + pattern=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is + set to a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the default + palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or + mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here colors) or the + bounds set in `marker.cmin` and `marker.cmax` Has an + effect only if colors is set to a numerical array. + Defaults to `false` when `marker.cmin` and + `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if colors is set to a + numerical array. Value should have the same units as + colors. Has no effect when `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.icicle.marker.ColorBar` + instance or dict with compatible properties + colors + Sets the color of each sector of this trace. If not + specified, the default trace color set is used to pick + the sector colors. + colorscale + Sets the colorscale. Has an effect only if colors is + set to a numerical array. 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, `[[0, + 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.icicle.marker.Line` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if colors is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the + array and `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if colors is set to a + numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colors", arg, colors) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorssrc", arg, colorssrc) + self._set_property("line", arg, line) + self._set_property("pattern", arg, pattern) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_outsidetextfont.py new file mode 100644 index 0000000..2e226d0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_outsidetextfont.py @@ -0,0 +1,591 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `textinfo` lying outside the sector. + This option refers to the root of the hierarchy presented on + top left corner of a treemap graph. Please note that if a + hierarchy has multiple root nodes, this option won't have any + effect and `insidetextfont` would be used. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_pathbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_pathbar.py new file mode 100644 index 0000000..828c24f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_pathbar.py @@ -0,0 +1,198 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pathbar(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.pathbar" + _valid_props = {"edgeshape", "side", "textfont", "thickness", "visible"} + + @property + def edgeshape(self): + """ + Determines which shape is used for edges between `barpath` + labels. + + The 'edgeshape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['>', '<', '|', '/', '\\'] + + Returns + ------- + Any + """ + return self["edgeshape"] + + @edgeshape.setter + def edgeshape(self, val): + self["edgeshape"] = val + + @property + def side(self): + """ + Determines on which side of the the treemap the `pathbar` + should be presented. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def textfont(self): + """ + Sets the font used inside `pathbar`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.pathbar.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.icicle.pathbar.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def thickness(self): + """ + Sets the thickness of `pathbar` (in px). If not specified the + `pathbar.textfont.size` is used with 3 pixles extra padding on + each side. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [12, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def visible(self): + """ + Determines if the path bar is drawn i.e. outside the trace + `domain` and with one pixel gap. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + edgeshape + Determines which shape is used for edges between + `barpath` labels. + side + Determines on which side of the the treemap the + `pathbar` should be presented. + textfont + Sets the font used inside `pathbar`. + thickness + Sets the thickness of `pathbar` (in px). If not + specified the `pathbar.textfont.size` is used with 3 + pixles extra padding on each side. + visible + Determines if the path bar is drawn i.e. outside the + trace `domain` and with one pixel gap. + """ + + def __init__( + self, + arg=None, + edgeshape=None, + side=None, + textfont=None, + thickness=None, + visible=None, + **kwargs, + ): + """ + Construct a new Pathbar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.Pathbar` + edgeshape + Determines which shape is used for edges between + `barpath` labels. + side + Determines on which side of the the treemap the + `pathbar` should be presented. + textfont + Sets the font used inside `pathbar`. + thickness + Sets the thickness of `pathbar` (in px). If not + specified the `pathbar.textfont.size` is used with 3 + pixles extra padding on each side. + visible + Determines if the path bar is drawn i.e. outside the + trace `domain` and with one pixel gap. + + Returns + ------- + Pathbar + """ + super().__init__("pathbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Pathbar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Pathbar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("edgeshape", arg, edgeshape) + self._set_property("side", arg, side) + self._set_property("textfont", arg, textfont) + self._set_property("thickness", arg, thickness) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_root.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_root.py new file mode 100644 index 0000000..563937c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_root.py @@ -0,0 +1,86 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Root(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.root" + _valid_props = {"color"} + + @property + def color(self): + """ + sets the color of the root node for a sunburst/treemap/icicle + trace. this has no effect when a colorscale is used to set the + markers. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + sets the color of the root node for a + sunburst/treemap/icicle trace. this has no effect when + a colorscale is used to set the markers. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Root object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.Root` + color + sets the color of the root node for a + sunburst/treemap/icicle trace. this has no effect when + a colorscale is used to set the markers. + + Returns + ------- + Root + """ + super().__init__("root") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Root +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Root`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_stream.py new file mode 100644 index 0000000..10fa9d9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_textfont.py new file mode 100644 index 0000000..5818410 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `textinfo`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_tiling.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_tiling.py new file mode 100644 index 0000000..9c382f1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/_tiling.py @@ -0,0 +1,153 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tiling(_BaseTraceHierarchyType): + _parent_path_str = "icicle" + _path_str = "icicle.tiling" + _valid_props = {"flip", "orientation", "pad"} + + @property + def flip(self): + """ + Determines if the positions obtained from solver are flipped on + each axis. + + The 'flip' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y'] joined with '+' characters + (e.g. 'x+y') + + Returns + ------- + Any + """ + return self["flip"] + + @flip.setter + def flip(self, val): + self["flip"] = val + + @property + def orientation(self): + """ + When set in conjunction with `tiling.flip`, determines on which + side the root nodes are drawn in the chart. If + `tiling.orientation` is "v" and `tiling.flip` is "", the root + nodes appear at the top. If `tiling.orientation` is "v" and + `tiling.flip` is "y", the root nodes appear at the bottom. If + `tiling.orientation` is "h" and `tiling.flip` is "", the root + nodes appear at the left. If `tiling.orientation` is "h" and + `tiling.flip` is "x", the root nodes appear at the right. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def pad(self): + """ + Sets the inner padding (in px). + + The 'pad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def _prop_descriptions(self): + return """\ + flip + Determines if the positions obtained from solver are + flipped on each axis. + orientation + When set in conjunction with `tiling.flip`, determines + on which side the root nodes are drawn in the chart. If + `tiling.orientation` is "v" and `tiling.flip` is "", + the root nodes appear at the top. If + `tiling.orientation` is "v" and `tiling.flip` is "y", + the root nodes appear at the bottom. If + `tiling.orientation` is "h" and `tiling.flip` is "", + the root nodes appear at the left. If + `tiling.orientation` is "h" and `tiling.flip` is "x", + the root nodes appear at the right. + pad + Sets the inner padding (in px). + """ + + def __init__(self, arg=None, flip=None, orientation=None, pad=None, **kwargs): + """ + Construct a new Tiling object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.Tiling` + flip + Determines if the positions obtained from solver are + flipped on each axis. + orientation + When set in conjunction with `tiling.flip`, determines + on which side the root nodes are drawn in the chart. If + `tiling.orientation` is "v" and `tiling.flip` is "", + the root nodes appear at the top. If + `tiling.orientation` is "v" and `tiling.flip` is "y", + the root nodes appear at the bottom. If + `tiling.orientation` is "h" and `tiling.flip` is "", + the root nodes appear at the left. If + `tiling.orientation` is "h" and `tiling.flip` is "x", + the root nodes appear at the right. + pad + Sets the inner padding (in px). + + Returns + ------- + Tiling + """ + super().__init__("tiling") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.Tiling +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.Tiling`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("flip", arg, flip) + self._set_property("orientation", arg, orientation) + self._set_property("pad", arg, pad) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/_font.py new file mode 100644 index 0000000..c4253a2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "icicle.hoverlabel" + _path_str = "icicle.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/_font.py new file mode 100644 index 0000000..cbeb577 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "icicle.legendgrouptitle" + _path_str = "icicle.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/__init__.py new file mode 100644 index 0000000..e2d7a12 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from ._pattern import Pattern + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_colorbar.py new file mode 100644 index 0000000..848f59a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker" + _path_str = "icicle.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.icicle.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.icicle.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.icicle.marker. + colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + icicle.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.icicle.marker.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.icicle + .marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + icicle.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.icicle.marker.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.icicle.marker.c + olorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.icicle + .marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + icicle.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.icicle.marker.colorbar.Tit + le` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_line.py new file mode 100644 index 0000000..ea00cd5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_line.py @@ -0,0 +1,163 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker" + _path_str = "icicle.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. Defaults to + the `paper_bgcolor` value. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.marker.Line` + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_pattern.py new file mode 100644 index 0000000..1e58174 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker" + _path_str = "icicle.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..03caedc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker.colorbar" + _path_str = "icicle.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.marker. + colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..1cdf63f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker.colorbar" + _path_str = "icicle.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.marker. + colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_title.py new file mode 100644 index 0000000..0e4f9ec --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker.colorbar" + _path_str = "icicle.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.icicle.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.icicle.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/_font.py new file mode 100644 index 0000000..8d4fec6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "icicle.marker.colorbar.title" + _path_str = "icicle.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.icicle.marker. + colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/__init__.py new file mode 100644 index 0000000..a713099 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/_textfont.py new file mode 100644 index 0000000..8df72dd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/icicle/pathbar/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "icicle.pathbar" + _path_str = "icicle.pathbar.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used inside `pathbar`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.icicle.pathbar.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.icicle.pathbar.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.icicle.pathbar.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/__init__.py new file mode 100644 index 0000000..7dc94b8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/__init__.py @@ -0,0 +1,21 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._stream import Stream + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_hoverlabel.py new file mode 100644 index 0000000..69435bd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "image" + _path_str = "image.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.image.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.image.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.image.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.image.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.image.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_legendgrouptitle.py new file mode 100644 index 0000000..7b24846 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "image" + _path_str = "image.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.image.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.image.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.image.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.image.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.image.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_stream.py new file mode 100644 index 0000000..7c0a3d3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "image" + _path_str = "image.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.image.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.image.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.image.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/_font.py new file mode 100644 index 0000000..1eb363f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "image.hoverlabel" + _path_str = "image.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.image.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.image.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.image.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/_font.py new file mode 100644 index 0000000..c3a46b3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/image/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "image.legendgrouptitle" + _path_str = "image.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.image.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.image.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.image.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/__init__.py new file mode 100644 index 0000000..d1ed63e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/__init__.py @@ -0,0 +1,32 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._delta import Delta + from ._domain import Domain + from ._gauge import Gauge + from ._legendgrouptitle import Legendgrouptitle + from ._number import Number + from ._stream import Stream + from ._title import Title + from . import delta + from . import gauge + from . import legendgrouptitle + from . import number + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".delta", ".gauge", ".legendgrouptitle", ".number", ".title"], + [ + "._delta.Delta", + "._domain.Domain", + "._gauge.Gauge", + "._legendgrouptitle.Legendgrouptitle", + "._number.Number", + "._stream.Stream", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_delta.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_delta.py new file mode 100644 index 0000000..97ff3e1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_delta.py @@ -0,0 +1,309 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Delta(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.delta" + _valid_props = { + "decreasing", + "font", + "increasing", + "position", + "prefix", + "reference", + "relative", + "suffix", + "valueformat", + } + + @property + def decreasing(self): + """ + The 'decreasing' property is an instance of Decreasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.delta.Decreasing` + - A dict of string/value properties that will be passed + to the Decreasing constructor + + Returns + ------- + plotly.graph_objs.indicator.delta.Decreasing + """ + return self["decreasing"] + + @decreasing.setter + def decreasing(self, val): + self["decreasing"] = val + + @property + def font(self): + """ + Set the font used to display the delta + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.delta.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.indicator.delta.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def increasing(self): + """ + The 'increasing' property is an instance of Increasing + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.delta.Increasing` + - A dict of string/value properties that will be passed + to the Increasing constructor + + Returns + ------- + plotly.graph_objs.indicator.delta.Increasing + """ + return self["increasing"] + + @increasing.setter + def increasing(self, val): + self["increasing"] = val + + @property + def position(self): + """ + Sets the position of delta with respect to the number. + + The 'position' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom', 'left', 'right'] + + Returns + ------- + Any + """ + return self["position"] + + @position.setter + def position(self, val): + self["position"] = val + + @property + def prefix(self): + """ + Sets a prefix appearing before the delta. + + The 'prefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["prefix"] + + @prefix.setter + def prefix(self, val): + self["prefix"] = val + + @property + def reference(self): + """ + Sets the reference value to compute the delta. By default, it + is set to the current value. + + The 'reference' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["reference"] + + @reference.setter + def reference(self, val): + self["reference"] = val + + @property + def relative(self): + """ + Show relative change + + The 'relative' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["relative"] + + @relative.setter + def relative(self, val): + self["relative"] = val + + @property + def suffix(self): + """ + Sets a suffix appearing next to the delta. + + The 'suffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["suffix"] + + @suffix.setter + def suffix(self, val): + self["suffix"] = val + + @property + def valueformat(self): + """ + Sets the value formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'valueformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["valueformat"] + + @valueformat.setter + def valueformat(self, val): + self["valueformat"] = val + + @property + def _prop_descriptions(self): + return """\ + decreasing + :class:`plotly.graph_objects.indicator.delta.Decreasing + ` instance or dict with compatible properties + font + Set the font used to display the delta + increasing + :class:`plotly.graph_objects.indicator.delta.Increasing + ` instance or dict with compatible properties + position + Sets the position of delta with respect to the number. + prefix + Sets a prefix appearing before the delta. + reference + Sets the reference value to compute the delta. By + default, it is set to the current value. + relative + Show relative change + suffix + Sets a suffix appearing next to the delta. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + """ + + def __init__( + self, + arg=None, + decreasing=None, + font=None, + increasing=None, + position=None, + prefix=None, + reference=None, + relative=None, + suffix=None, + valueformat=None, + **kwargs, + ): + """ + Construct a new Delta object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Delta` + decreasing + :class:`plotly.graph_objects.indicator.delta.Decreasing + ` instance or dict with compatible properties + font + Set the font used to display the delta + increasing + :class:`plotly.graph_objects.indicator.delta.Increasing + ` instance or dict with compatible properties + position + Sets the position of delta with respect to the number. + prefix + Sets a prefix appearing before the delta. + reference + Sets the reference value to compute the delta. By + default, it is set to the current value. + relative + Show relative change + suffix + Sets a suffix appearing next to the delta. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + Returns + ------- + Delta + """ + super().__init__("delta") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Delta +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Delta`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("decreasing", arg, decreasing) + self._set_property("font", arg, font) + self._set_property("increasing", arg, increasing) + self._set_property("position", arg, position) + self._set_property("prefix", arg, prefix) + self._set_property("reference", arg, reference) + self._set_property("relative", arg, relative) + self._set_property("suffix", arg, suffix) + self._set_property("valueformat", arg, valueformat) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_domain.py new file mode 100644 index 0000000..1aaf4e6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this indicator trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this indicator trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this indicator trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this indicator trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this indicator trace . + row + If there is a layout grid, use the domain for this row + in the grid for this indicator trace . + x + Sets the horizontal domain of this indicator trace (in + plot fraction). + y + Sets the vertical domain of this indicator trace (in + plot fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this indicator trace . + row + If there is a layout grid, use the domain for this row + in the grid for this indicator trace . + x + Sets the horizontal domain of this indicator trace (in + plot fraction). + y + Sets the vertical domain of this indicator trace (in + plot fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_gauge.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_gauge.py new file mode 100644 index 0000000..1fde32d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_gauge.py @@ -0,0 +1,323 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gauge(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.gauge" + _valid_props = { + "axis", + "bar", + "bgcolor", + "bordercolor", + "borderwidth", + "shape", + "stepdefaults", + "steps", + "threshold", + } + + @property + def axis(self): + """ + The 'axis' property is an instance of Axis + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.Axis` + - A dict of string/value properties that will be passed + to the Axis constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.Axis + """ + return self["axis"] + + @axis.setter + def axis(self, val): + self["axis"] = val + + @property + def bar(self): + """ + Set the appearance of the gauge's value + + The 'bar' property is an instance of Bar + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.Bar` + - A dict of string/value properties that will be passed + to the Bar constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.Bar + """ + return self["bar"] + + @bar.setter + def bar(self, val): + self["bar"] = val + + @property + def bgcolor(self): + """ + Sets the gauge background color. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the gauge. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the gauge. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def shape(self): + """ + Set the shape of the gauge + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['angular', 'bullet'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def steps(self): + """ + The 'steps' property is a tuple of instances of + Step that may be specified as: + - A list or tuple of instances of plotly.graph_objs.indicator.gauge.Step + - A list or tuple of dicts of string/value properties that + will be passed to the Step constructor + + Returns + ------- + tuple[plotly.graph_objs.indicator.gauge.Step] + """ + return self["steps"] + + @steps.setter + def steps(self, val): + self["steps"] = val + + @property + def stepdefaults(self): + """ + When used in a template (as + layout.template.data.indicator.gauge.stepdefaults), sets the + default property values to use for elements of + indicator.gauge.steps + + The 'stepdefaults' property is an instance of Step + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.Step` + - A dict of string/value properties that will be passed + to the Step constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.Step + """ + return self["stepdefaults"] + + @stepdefaults.setter + def stepdefaults(self, val): + self["stepdefaults"] = val + + @property + def threshold(self): + """ + The 'threshold' property is an instance of Threshold + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.Threshold` + - A dict of string/value properties that will be passed + to the Threshold constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.Threshold + """ + return self["threshold"] + + @threshold.setter + def threshold(self, val): + self["threshold"] = val + + @property + def _prop_descriptions(self): + return """\ + axis + :class:`plotly.graph_objects.indicator.gauge.Axis` + instance or dict with compatible properties + bar + Set the appearance of the gauge's value + bgcolor + Sets the gauge background color. + bordercolor + Sets the color of the border enclosing the gauge. + borderwidth + Sets the width (in px) of the border enclosing the + gauge. + shape + Set the shape of the gauge + steps + A tuple of + :class:`plotly.graph_objects.indicator.gauge.Step` + instances or dicts with compatible properties + stepdefaults + When used in a template (as + layout.template.data.indicator.gauge.stepdefaults), + sets the default property values to use for elements of + indicator.gauge.steps + threshold + :class:`plotly.graph_objects.indicator.gauge.Threshold` + instance or dict with compatible properties + """ + + def __init__( + self, + arg=None, + axis=None, + bar=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + shape=None, + steps=None, + stepdefaults=None, + threshold=None, + **kwargs, + ): + """ + Construct a new Gauge object + + The gauge of the Indicator plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Gauge` + axis + :class:`plotly.graph_objects.indicator.gauge.Axis` + instance or dict with compatible properties + bar + Set the appearance of the gauge's value + bgcolor + Sets the gauge background color. + bordercolor + Sets the color of the border enclosing the gauge. + borderwidth + Sets the width (in px) of the border enclosing the + gauge. + shape + Set the shape of the gauge + steps + A tuple of + :class:`plotly.graph_objects.indicator.gauge.Step` + instances or dicts with compatible properties + stepdefaults + When used in a template (as + layout.template.data.indicator.gauge.stepdefaults), + sets the default property values to use for elements of + indicator.gauge.steps + threshold + :class:`plotly.graph_objects.indicator.gauge.Threshold` + instance or dict with compatible properties + + Returns + ------- + Gauge + """ + super().__init__("gauge") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Gauge +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Gauge`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("axis", arg, axis) + self._set_property("bar", arg, bar) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("shape", arg, shape) + self._set_property("steps", arg, steps) + self._set_property("stepdefaults", arg, stepdefaults) + self._set_property("threshold", arg, threshold) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_legendgrouptitle.py new file mode 100644 index 0000000..d4767c7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.indicator.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_number.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_number.py new file mode 100644 index 0000000..487d4fd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_number.py @@ -0,0 +1,163 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Number(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.number" + _valid_props = {"font", "prefix", "suffix", "valueformat"} + + @property + def font(self): + """ + Set the font used to display main number + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.number.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.indicator.number.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def prefix(self): + """ + Sets a prefix appearing before the number. + + The 'prefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["prefix"] + + @prefix.setter + def prefix(self, val): + self["prefix"] = val + + @property + def suffix(self): + """ + Sets a suffix appearing next to the number. + + The 'suffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["suffix"] + + @suffix.setter + def suffix(self, val): + self["suffix"] = val + + @property + def valueformat(self): + """ + Sets the value formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'valueformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["valueformat"] + + @valueformat.setter + def valueformat(self, val): + self["valueformat"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Set the font used to display main number + prefix + Sets a prefix appearing before the number. + suffix + Sets a suffix appearing next to the number. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + """ + + def __init__( + self, arg=None, font=None, prefix=None, suffix=None, valueformat=None, **kwargs + ): + """ + Construct a new Number object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Number` + font + Set the font used to display main number + prefix + Sets a prefix appearing before the number. + suffix + Sets a suffix appearing next to the number. + valueformat + Sets the value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + Returns + ------- + Number + """ + super().__init__("number") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Number +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Number`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("prefix", arg, prefix) + self._set_property("suffix", arg, suffix) + self._set_property("valueformat", arg, valueformat) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_stream.py new file mode 100644 index 0000000..0b793d0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_title.py new file mode 100644 index 0000000..68f71ab --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/_title.py @@ -0,0 +1,134 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "indicator" + _path_str = "indicator.title" + _valid_props = {"align", "font", "text"} + + @property + def align(self): + """ + Sets the horizontal alignment of the title. It defaults to + `center` except for bullet charts for which it defaults to + right. + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def font(self): + """ + Set the font used to display the title + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.indicator.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this indicator. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the title. It defaults + to `center` except for bullet charts for which it + defaults to right. + font + Set the font used to display the title + text + Sets the title of this indicator. + """ + + def __init__(self, arg=None, align=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.Title` + align + Sets the horizontal alignment of the title. It defaults + to `center` except for bullet charts for which it + defaults to right. + font + Set the font used to display the title + text + Sets the title of this indicator. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/__init__.py new file mode 100644 index 0000000..6b93968 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/__init__.py @@ -0,0 +1,15 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._decreasing import Decreasing + from ._font import Font + from ._increasing import Increasing +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [], + ["._decreasing.Decreasing", "._font.Font", "._increasing.Increasing"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_decreasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_decreasing.py new file mode 100644 index 0000000..4364427 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_decreasing.py @@ -0,0 +1,105 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Decreasing(_BaseTraceHierarchyType): + _parent_path_str = "indicator.delta" + _path_str = "indicator.delta.decreasing" + _valid_props = {"color", "symbol"} + + @property + def color(self): + """ + Sets the color for increasing value. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symbol(self): + """ + Sets the symbol to display for increasing value + + The 'symbol' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color for increasing value. + symbol + Sets the symbol to display for increasing value + """ + + def __init__(self, arg=None, color=None, symbol=None, **kwargs): + """ + Construct a new Decreasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.delta.Decreasing` + color + Sets the color for increasing value. + symbol + Sets the symbol to display for increasing value + + Returns + ------- + Decreasing + """ + super().__init__("decreasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.delta.Decreasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.delta.Decreasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("symbol", arg, symbol) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_font.py new file mode 100644 index 0000000..a30bb94 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "indicator.delta" + _path_str = "indicator.delta.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Set the font used to display the delta + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.delta.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.delta.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.delta.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_increasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_increasing.py new file mode 100644 index 0000000..91ee3b2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/delta/_increasing.py @@ -0,0 +1,105 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Increasing(_BaseTraceHierarchyType): + _parent_path_str = "indicator.delta" + _path_str = "indicator.delta.increasing" + _valid_props = {"color", "symbol"} + + @property + def color(self): + """ + Sets the color for increasing value. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symbol(self): + """ + Sets the symbol to display for increasing value + + The 'symbol' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color for increasing value. + symbol + Sets the symbol to display for increasing value + """ + + def __init__(self, arg=None, color=None, symbol=None, **kwargs): + """ + Construct a new Increasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.delta.Increasing` + color + Sets the color for increasing value. + symbol + Sets the symbol to display for increasing value + + Returns + ------- + Increasing + """ + super().__init__("increasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.delta.Increasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.delta.Increasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("symbol", arg, symbol) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/__init__.py new file mode 100644 index 0000000..cad4a3b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/__init__.py @@ -0,0 +1,20 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._axis import Axis + from ._bar import Bar + from ._step import Step + from ._threshold import Threshold + from . import axis + from . import bar + from . import step + from . import threshold +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".axis", ".bar", ".step", ".threshold"], + ["._axis.Axis", "._bar.Bar", "._step.Step", "._threshold.Threshold"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_axis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_axis.py new file mode 100644 index 0000000..83ba584 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_axis.py @@ -0,0 +1,1108 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Axis(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge" + _path_str = "indicator.gauge.axis" + _valid_props = { + "dtick", + "exponentformat", + "labelalias", + "minexponent", + "nticks", + "range", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "visible", + } + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property is a number and may be specified as: + - An int or float + (1) The 'range[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.axis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.indicator.gauge.axis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.indicator.gauge.axis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.indicator.gaug + e.axis.tickformatstopdefaults), sets the default property + values to use for elements of + indicator.gauge.axis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.axis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.indicator.gauge + .axis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.indica + tor.gauge.axis.tickformatstopdefaults), sets the + default property values to use for elements of + indicator.gauge.axis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + def __init__( + self, + arg=None, + dtick=None, + exponentformat=None, + labelalias=None, + minexponent=None, + nticks=None, + range=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + visible=None, + **kwargs, + ): + """ + Construct a new Axis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.gauge.Axis` + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.indicator.gauge + .axis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.indica + tor.gauge.axis.tickformatstopdefaults), sets the + default property values to use for elements of + indicator.gauge.axis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + Axis + """ + super().__init__("axis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.Axis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.Axis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_bar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_bar.py new file mode 100644 index 0000000..622dc9e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_bar.py @@ -0,0 +1,135 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Bar(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge" + _path_str = "indicator.gauge.bar" + _valid_props = {"color", "line", "thickness"} + + @property + def color(self): + """ + Sets the background color of the arc. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.bar.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.bar.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def thickness(self): + """ + Sets the thickness of the bar as a fraction of the total + thickness of the gauge. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the background color of the arc. + line + :class:`plotly.graph_objects.indicator.gauge.bar.Line` + instance or dict with compatible properties + thickness + Sets the thickness of the bar as a fraction of the + total thickness of the gauge. + """ + + def __init__(self, arg=None, color=None, line=None, thickness=None, **kwargs): + """ + Construct a new Bar object + + Set the appearance of the gauge's value + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.gauge.Bar` + color + Sets the background color of the arc. + line + :class:`plotly.graph_objects.indicator.gauge.bar.Line` + instance or dict with compatible properties + thickness + Sets the thickness of the bar as a fraction of the + total thickness of the gauge. + + Returns + ------- + Bar + """ + super().__init__("bar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.Bar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.Bar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._set_property("thickness", arg, thickness) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_step.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_step.py new file mode 100644 index 0000000..c683b9b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_step.py @@ -0,0 +1,262 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Step(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge" + _path_str = "indicator.gauge.step" + _valid_props = {"color", "line", "name", "range", "templateitemname", "thickness"} + + @property + def color(self): + """ + Sets the background color of the arc. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.step.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.step.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def range(self): + """ + Sets the range of this axis. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property is a number and may be specified as: + - An int or float + (1) The 'range[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def thickness(self): + """ + Sets the thickness of the bar as a fraction of the total + thickness of the gauge. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the background color of the arc. + line + :class:`plotly.graph_objects.indicator.gauge.step.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + range + Sets the range of this axis. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + thickness + Sets the thickness of the bar as a fraction of the + total thickness of the gauge. + """ + + def __init__( + self, + arg=None, + color=None, + line=None, + name=None, + range=None, + templateitemname=None, + thickness=None, + **kwargs, + ): + """ + Construct a new Step object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.gauge.Step` + color + Sets the background color of the arc. + line + :class:`plotly.graph_objects.indicator.gauge.step.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + range + Sets the range of this axis. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + thickness + Sets the thickness of the bar as a fraction of the + total thickness of the gauge. + + Returns + ------- + Step + """ + super().__init__("steps") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.Step +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.Step`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._set_property("name", arg, name) + self._set_property("range", arg, range) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("thickness", arg, thickness) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_threshold.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_threshold.py new file mode 100644 index 0000000..acee114 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/_threshold.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Threshold(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge" + _path_str = "indicator.gauge.threshold" + _valid_props = {"line", "thickness", "value"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.indicator.gauge.threshold.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.indicator.gauge.threshold.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def thickness(self): + """ + Sets the thickness of the threshold line as a fraction of the + thickness of the gauge. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def value(self): + """ + Sets a treshold value drawn as a line. + + The 'value' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.indicator.gauge.threshold. + Line` instance or dict with compatible properties + thickness + Sets the thickness of the threshold line as a fraction + of the thickness of the gauge. + value + Sets a treshold value drawn as a line. + """ + + def __init__(self, arg=None, line=None, thickness=None, value=None, **kwargs): + """ + Construct a new Threshold object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.gauge.Threshold` + line + :class:`plotly.graph_objects.indicator.gauge.threshold. + Line` instance or dict with compatible properties + thickness + Sets the thickness of the threshold line as a fraction + of the thickness of the gauge. + value + Sets a treshold value drawn as a line. + + Returns + ------- + Threshold + """ + super().__init__("threshold") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.Threshold +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.Threshold`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("thickness", arg, thickness) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/__init__.py new file mode 100644 index 0000000..1dfbe47 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickfont.py new file mode 100644 index 0000000..22ed546 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge.axis" + _path_str = "indicator.gauge.axis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.indicator.gaug + e.axis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.axis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py new file mode 100644 index 0000000..d9f8c19 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/axis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge.axis" + _path_str = "indicator.gauge.axis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.indicator.gaug + e.axis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.axis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.axis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/_line.py new file mode 100644 index 0000000..4b6a842 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/bar/_line.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge.bar" + _path_str = "indicator.gauge.bar.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + width + Sets the width (in px) of the line enclosing each + sector. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.gauge.bar.Line` + color + Sets the color of the line enclosing each sector. + width + Sets the width (in px) of the line enclosing each + sector. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.bar.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.bar.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/_line.py new file mode 100644 index 0000000..66e52fe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/step/_line.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge.step" + _path_str = "indicator.gauge.step.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + width + Sets the width (in px) of the line enclosing each + sector. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.gauge.step.Line` + color + Sets the color of the line enclosing each sector. + width + Sets the width (in px) of the line enclosing each + sector. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.step.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.step.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/_line.py new file mode 100644 index 0000000..39cc174 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/gauge/threshold/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "indicator.gauge.threshold" + _path_str = "indicator.gauge.threshold.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of the threshold line. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of the threshold line. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the threshold line. + width + Sets the width (in px) of the threshold line. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.indicator.gaug + e.threshold.Line` + color + Sets the color of the threshold line. + width + Sets the width (in px) of the threshold line. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.gauge.threshold.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.gauge.threshold.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/_font.py new file mode 100644 index 0000000..6cd1574 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "indicator.legendgrouptitle" + _path_str = "indicator.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.indicator.lege + ndgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/_font.py new file mode 100644 index 0000000..48dedbd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/number/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "indicator.number" + _path_str = "indicator.number.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Set the font used to display main number + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.number.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.number.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.number.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/_font.py new file mode 100644 index 0000000..4407ab2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/indicator/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "indicator.title" + _path_str = "indicator.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Set the font used to display the title + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.indicator.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.indicator.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.indicator.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/__init__.py new file mode 100644 index 0000000..27f503c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/__init__.py @@ -0,0 +1,40 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._caps import Caps + from ._colorbar import ColorBar + from ._contour import Contour + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._lighting import Lighting + from ._lightposition import Lightposition + from ._slices import Slices + from ._spaceframe import Spaceframe + from ._stream import Stream + from ._surface import Surface + from . import caps + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle + from . import slices +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".caps", ".colorbar", ".hoverlabel", ".legendgrouptitle", ".slices"], + [ + "._caps.Caps", + "._colorbar.ColorBar", + "._contour.Contour", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._lighting.Lighting", + "._lightposition.Lightposition", + "._slices.Slices", + "._spaceframe.Spaceframe", + "._stream.Stream", + "._surface.Surface", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_caps.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_caps.py new file mode 100644 index 0000000..e54a7e0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_caps.py @@ -0,0 +1,132 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Caps(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.caps" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.caps.X` + - A dict of string/value properties that will be passed + to the X constructor + + Returns + ------- + plotly.graph_objs.isosurface.caps.X + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.caps.Y` + - A dict of string/value properties that will be passed + to the Y constructor + + Returns + ------- + plotly.graph_objs.isosurface.caps.Y + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.caps.Z` + - A dict of string/value properties that will be passed + to the Z constructor + + Returns + ------- + plotly.graph_objs.isosurface.caps.Z + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + :class:`plotly.graph_objects.isosurface.caps.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.isosurface.caps.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.isosurface.caps.Z` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Caps object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Caps` + x + :class:`plotly.graph_objects.isosurface.caps.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.isosurface.caps.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.isosurface.caps.Z` + instance or dict with compatible properties + + Returns + ------- + Caps + """ + super().__init__("caps") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Caps +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Caps`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_colorbar.py new file mode 100644 index 0000000..fff5911 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_colorbar.py @@ -0,0 +1,1721 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.isosurface.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.isosurface.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.isosurface.col + orbar.tickformatstopdefaults), sets the default property values + to use for elements of isosurface.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.isosurface.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.isosur + face.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + isosurface.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.isosurface.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.isosurface.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.isosur + face.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + isosurface.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.isosurface.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_contour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_contour.py new file mode 100644 index 0000000..9032da2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_contour.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contour(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.contour" + _valid_props = {"color", "show", "width"} + + @property + def color(self): + """ + Sets the color of the contour lines. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def show(self): + """ + Sets whether or not dynamic contours are shown on hover + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def width(self): + """ + Sets the width of the contour lines. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + """ + + def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): + """ + Construct a new Contour object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Contour` + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + + Returns + ------- + Contour + """ + super().__init__("contour") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Contour +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Contour`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("show", arg, show) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_hoverlabel.py new file mode 100644 index 0000000..51a6cca --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.isosurface.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_legendgrouptitle.py new file mode 100644 index 0000000..bff6425 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.isosurface.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lighting.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lighting.py new file mode 100644 index 0000000..e5b9e8f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lighting.py @@ -0,0 +1,260 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.lighting" + _valid_props = { + "ambient", + "diffuse", + "facenormalsepsilon", + "fresnel", + "roughness", + "specular", + "vertexnormalsepsilon", + } + + @property + def ambient(self): + """ + Ambient light increases overall color visibility but can wash + out the image. + + The 'ambient' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ambient"] + + @ambient.setter + def ambient(self, val): + self["ambient"] = val + + @property + def diffuse(self): + """ + Represents the extent that incident rays are reflected in a + range of angles. + + The 'diffuse' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["diffuse"] + + @diffuse.setter + def diffuse(self, val): + self["diffuse"] = val + + @property + def facenormalsepsilon(self): + """ + Epsilon for face normals calculation avoids math issues arising + from degenerate geometry. + + The 'facenormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["facenormalsepsilon"] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self["facenormalsepsilon"] = val + + @property + def fresnel(self): + """ + Represents the reflectance as a dependency of the viewing + angle; e.g. paper is reflective when viewing it from the edge + of the paper (almost 90 degrees), causing shine. + + The 'fresnel' property is a number and may be specified as: + - An int or float in the interval [0, 5] + + Returns + ------- + int|float + """ + return self["fresnel"] + + @fresnel.setter + def fresnel(self, val): + self["fresnel"] = val + + @property + def roughness(self): + """ + Alters specular reflection; the rougher the surface, the wider + and less contrasty the shine. + + The 'roughness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["roughness"] + + @roughness.setter + def roughness(self, val): + self["roughness"] = val + + @property + def specular(self): + """ + Represents the level that incident rays are reflected in a + single direction, causing shine. + + The 'specular' property is a number and may be specified as: + - An int or float in the interval [0, 2] + + Returns + ------- + int|float + """ + return self["specular"] + + @specular.setter + def specular(self, val): + self["specular"] = val + + @property + def vertexnormalsepsilon(self): + """ + Epsilon for vertex normals calculation avoids math issues + arising from degenerate geometry. + + The 'vertexnormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["vertexnormalsepsilon"] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self["vertexnormalsepsilon"] = val + + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs, + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Lighting` + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super().__init__("lighting") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Lighting +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Lighting`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("ambient", arg, ambient) + self._set_property("diffuse", arg, diffuse) + self._set_property("facenormalsepsilon", arg, facenormalsepsilon) + self._set_property("fresnel", arg, fresnel) + self._set_property("roughness", arg, roughness) + self._set_property("specular", arg, specular) + self._set_property("vertexnormalsepsilon", arg, vertexnormalsepsilon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lightposition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lightposition.py new file mode 100644 index 0000000..07e99a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_lightposition.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.lightposition" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Numeric vector, representing the X coordinate for each vertex. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Numeric vector, representing the Y coordinate for each vertex. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Numeric vector, representing the Z coordinate for each vertex. + + The 'z' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Lightposition` + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super().__init__("lightposition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Lightposition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Lightposition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_slices.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_slices.py new file mode 100644 index 0000000..df6b483 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_slices.py @@ -0,0 +1,132 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Slices(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.slices" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.slices.X` + - A dict of string/value properties that will be passed + to the X constructor + + Returns + ------- + plotly.graph_objs.isosurface.slices.X + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.slices.Y` + - A dict of string/value properties that will be passed + to the Y constructor + + Returns + ------- + plotly.graph_objs.isosurface.slices.Y + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.slices.Z` + - A dict of string/value properties that will be passed + to the Z constructor + + Returns + ------- + plotly.graph_objs.isosurface.slices.Z + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + :class:`plotly.graph_objects.isosurface.slices.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.isosurface.slices.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.isosurface.slices.Z` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Slices object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Slices` + x + :class:`plotly.graph_objects.isosurface.slices.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.isosurface.slices.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.isosurface.slices.Z` + instance or dict with compatible properties + + Returns + ------- + Slices + """ + super().__init__("slices") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Slices +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Slices`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_spaceframe.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_spaceframe.py new file mode 100644 index 0000000..8aa7d75 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_spaceframe.py @@ -0,0 +1,122 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Spaceframe(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.spaceframe" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `spaceframe` elements. The default + fill value is 0.15 meaning that only 15% of the area of every + faces of tetras would be shaded. Applying a greater `fill` + ratio would allow the creation of stronger elements or could be + sued to have entirely closed areas (in case of using 1). + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Displays/hides tetrahedron shapes between minimum and maximum + iso-values. Often useful when either caps or surfaces are + disabled or filled with values less than 1. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `spaceframe` elements. The + default fill value is 0.15 meaning that only 15% of the + area of every faces of tetras would be shaded. Applying + a greater `fill` ratio would allow the creation of + stronger elements or could be sued to have entirely + closed areas (in case of using 1). + show + Displays/hides tetrahedron shapes between minimum and + maximum iso-values. Often useful when either caps or + surfaces are disabled or filled with values less than + 1. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Spaceframe object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Spaceframe` + fill + Sets the fill ratio of the `spaceframe` elements. The + default fill value is 0.15 meaning that only 15% of the + area of every faces of tetras would be shaded. Applying + a greater `fill` ratio would allow the creation of + stronger elements or could be sued to have entirely + closed areas (in case of using 1). + show + Displays/hides tetrahedron shapes between minimum and + maximum iso-values. Often useful when either caps or + surfaces are disabled or filled with values less than + 1. + + Returns + ------- + Spaceframe + """ + super().__init__("spaceframe") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Spaceframe +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Spaceframe`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_stream.py new file mode 100644 index 0000000..ee2809f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_surface.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_surface.py new file mode 100644 index 0000000..605e7fd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/_surface.py @@ -0,0 +1,193 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Surface(_BaseTraceHierarchyType): + _parent_path_str = "isosurface" + _path_str = "isosurface.surface" + _valid_props = {"count", "fill", "pattern", "show"} + + @property + def count(self): + """ + Sets the number of iso-surfaces between minimum and maximum + iso-values. By default this value is 2 meaning that only + minimum and maximum surfaces would be drawn. + + The 'count' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["count"] + + @count.setter + def count(self, val): + self["count"] = val + + @property + def fill(self): + """ + Sets the fill ratio of the iso-surface. The default fill value + of the surface is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def pattern(self): + """ + Sets the surface pattern of the iso-surface 3-D sections. The + default pattern of the surface is `all` meaning that the rest + of surface elements would be shaded. The check options (either + 1 or 2) could be used to draw half of the squares on the + surface. Using various combinations of capital `A`, `B`, `C`, + `D` and `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of interest. + + The 'pattern' property is a flaglist and may be specified + as a string containing: + - Any combination of ['A', 'B', 'C', 'D', 'E'] joined with '+' characters + (e.g. 'A+B') + OR exactly one of ['all', 'odd', 'even'] (e.g. 'even') + + Returns + ------- + Any + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def show(self): + """ + Hides/displays surfaces between minimum and maximum iso-values. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + count + Sets the number of iso-surfaces between minimum and + maximum iso-values. By default this value is 2 meaning + that only minimum and maximum surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The default + fill value of the surface is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is `all` + meaning that the rest of surface elements would be + shaded. The check options (either 1 or 2) could be used + to draw half of the squares on the surface. Using + various combinations of capital `A`, `B`, `C`, `D` and + `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and maximum + iso-values. + """ + + def __init__( + self, arg=None, count=None, fill=None, pattern=None, show=None, **kwargs + ): + """ + Construct a new Surface object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.Surface` + count + Sets the number of iso-surfaces between minimum and + maximum iso-values. By default this value is 2 meaning + that only minimum and maximum surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The default + fill value of the surface is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is `all` + meaning that the rest of surface elements would be + shaded. The check options (either 1 or 2) could be used + to draw half of the squares on the surface. Using + various combinations of capital `A`, `B`, `C`, `D` and + `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and maximum + iso-values. + + Returns + ------- + Surface + """ + super().__init__("surface") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.Surface +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.Surface`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("count", arg, count) + self._set_property("fill", arg, fill) + self._set_property("pattern", arg, pattern) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/__init__.py new file mode 100644 index 0000000..3802eba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._x import X + from ._y import Y + from ._z import Z +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._x.X", "._y.Y", "._z.Z"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_x.py new file mode 100644 index 0000000..c93cb6d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_x.py @@ -0,0 +1,122 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.caps" + _path_str = "isosurface.caps.x" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + the `caps` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the x `slices` is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the x `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.caps.X` + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the x `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + + Returns + ------- + X + """ + super().__init__("x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.caps.X +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.caps.X`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_y.py new file mode 100644 index 0000000..fe3a13e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_y.py @@ -0,0 +1,122 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.caps" + _path_str = "isosurface.caps.y" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + the `caps` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the y `slices` is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the y `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.caps.Y` + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the y `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + + Returns + ------- + Y + """ + super().__init__("y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.caps.Y +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.caps.Y`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_z.py new file mode 100644 index 0000000..b60831e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/caps/_z.py @@ -0,0 +1,122 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.caps" + _path_str = "isosurface.caps.z" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + the `caps` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the z `slices` is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the z `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.caps.Z` + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the z `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + + Returns + ------- + Z + """ + super().__init__("z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.caps.Z +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.caps.Z`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickfont.py new file mode 100644 index 0000000..16009fe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.colorbar" + _path_str = "isosurface.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py new file mode 100644 index 0000000..faa7b68 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.colorbar" + _path_str = "isosurface.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.isosurface.col + orbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_title.py new file mode 100644 index 0000000..c19b2b5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.colorbar" + _path_str = "isosurface.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.isosurface.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.isosurface.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/_font.py new file mode 100644 index 0000000..1ee65df --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.colorbar.title" + _path_str = "isosurface.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.isosurface.col + orbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/_font.py new file mode 100644 index 0000000..a5ca352 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.hoverlabel" + _path_str = "isosurface.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/_font.py new file mode 100644 index 0000000..2297567 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.legendgrouptitle" + _path_str = "isosurface.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.isosurface.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/__init__.py new file mode 100644 index 0000000..3802eba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._x import X + from ._y import Y + from ._z import Z +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._x.X", "._y.Y", "._z.Z"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_x.py new file mode 100644 index 0000000..a47a8f9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_x.py @@ -0,0 +1,177 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.slices" + _path_str = "isosurface.slices.x" + _valid_props = {"fill", "locations", "locationssrc", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the `slices` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + specified slices would be created for all points of the axis x + except start and end. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def show(self): + """ + Determines whether or not slice planes about the x dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis x except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the x + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs, + ): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.slices.X` + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis x except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the x + dimension are drawn. + + Returns + ------- + X + """ + super().__init__("x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.slices.X +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.slices.X`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_y.py new file mode 100644 index 0000000..29e54ef --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_y.py @@ -0,0 +1,177 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.slices" + _path_str = "isosurface.slices.y" + _valid_props = {"fill", "locations", "locationssrc", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the `slices` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + specified slices would be created for all points of the axis y + except start and end. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def show(self): + """ + Determines whether or not slice planes about the y dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis y except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the y + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs, + ): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.slices.Y` + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis y except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the y + dimension are drawn. + + Returns + ------- + Y + """ + super().__init__("y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.slices.Y +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.slices.Y`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_z.py new file mode 100644 index 0000000..2aa0012 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/isosurface/slices/_z.py @@ -0,0 +1,177 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + _parent_path_str = "isosurface.slices" + _path_str = "isosurface.slices.z" + _valid_props = {"fill", "locations", "locationssrc", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the `slices` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + specified slices would be created for all points of the axis z + except start and end. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def show(self): + """ + Determines whether or not slice planes about the z dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis z except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the z + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs, + ): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.isosurface.slices.Z` + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis z except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the z + dimension are drawn. + + Returns + ------- + Z + """ + super().__init__("z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.isosurface.slices.Z +constructor must be a dict or +an instance of :class:`plotly.graph_objs.isosurface.slices.Z`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/__init__.py new file mode 100644 index 0000000..9fe6cad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/__init__.py @@ -0,0 +1,120 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._activeselection import Activeselection + from ._activeshape import Activeshape + from ._annotation import Annotation + from ._coloraxis import Coloraxis + from ._colorscale import Colorscale + from ._font import Font + from ._geo import Geo + from ._grid import Grid + from ._hoverlabel import Hoverlabel + from ._image import Image + from ._legend import Legend + from ._map import Map + from ._mapbox import Mapbox + from ._margin import Margin + from ._modebar import Modebar + from ._newselection import Newselection + from ._newshape import Newshape + from ._polar import Polar + from ._scene import Scene + from ._selection import Selection + from ._shape import Shape + from ._slider import Slider + from ._smith import Smith + from ._template import Template + from ._ternary import Ternary + from ._title import Title + from ._transition import Transition + from ._uniformtext import Uniformtext + from ._updatemenu import Updatemenu + from ._xaxis import XAxis + from ._yaxis import YAxis + from . import annotation + from . import coloraxis + from . import geo + from . import grid + from . import hoverlabel + from . import legend + from . import map + from . import mapbox + from . import newselection + from . import newshape + from . import polar + from . import scene + from . import selection + from . import shape + from . import slider + from . import smith + from . import template + from . import ternary + from . import title + from . import updatemenu + from . import xaxis + from . import yaxis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".annotation", + ".coloraxis", + ".geo", + ".grid", + ".hoverlabel", + ".legend", + ".map", + ".mapbox", + ".newselection", + ".newshape", + ".polar", + ".scene", + ".selection", + ".shape", + ".slider", + ".smith", + ".template", + ".ternary", + ".title", + ".updatemenu", + ".xaxis", + ".yaxis", + ], + [ + "._activeselection.Activeselection", + "._activeshape.Activeshape", + "._annotation.Annotation", + "._coloraxis.Coloraxis", + "._colorscale.Colorscale", + "._font.Font", + "._geo.Geo", + "._grid.Grid", + "._hoverlabel.Hoverlabel", + "._image.Image", + "._legend.Legend", + "._map.Map", + "._mapbox.Mapbox", + "._margin.Margin", + "._modebar.Modebar", + "._newselection.Newselection", + "._newshape.Newshape", + "._polar.Polar", + "._scene.Scene", + "._selection.Selection", + "._shape.Shape", + "._slider.Slider", + "._smith.Smith", + "._template.Template", + "._ternary.Ternary", + "._title.Title", + "._transition.Transition", + "._uniformtext.Uniformtext", + "._updatemenu.Updatemenu", + "._xaxis.XAxis", + "._yaxis.YAxis", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeselection.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeselection.py new file mode 100644 index 0000000..df89476 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeselection.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Activeselection(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.activeselection" + _valid_props = {"fillcolor", "opacity"} + + @property + def fillcolor(self): + """ + Sets the color filling the active selection' interior. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def opacity(self): + """ + Sets the opacity of the active selection. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the color filling the active selection' interior. + opacity + Sets the opacity of the active selection. + """ + + def __init__(self, arg=None, fillcolor=None, opacity=None, **kwargs): + """ + Construct a new Activeselection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Activeselection` + fillcolor + Sets the color filling the active selection' interior. + opacity + Sets the opacity of the active selection. + + Returns + ------- + Activeselection + """ + super().__init__("activeselection") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Activeselection +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Activeselection`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fillcolor", arg, fillcolor) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeshape.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeshape.py new file mode 100644 index 0000000..e350187 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_activeshape.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Activeshape(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.activeshape" + _valid_props = {"fillcolor", "opacity"} + + @property + def fillcolor(self): + """ + Sets the color filling the active shape' interior. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def opacity(self): + """ + Sets the opacity of the active shape. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the color filling the active shape' interior. + opacity + Sets the opacity of the active shape. + """ + + def __init__(self, arg=None, fillcolor=None, opacity=None, **kwargs): + """ + Construct a new Activeshape object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Activeshape` + fillcolor + Sets the color filling the active shape' interior. + opacity + Sets the opacity of the active shape. + + Returns + ------- + Activeshape + """ + super().__init__("activeshape") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Activeshape +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Activeshape`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fillcolor", arg, fillcolor) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_annotation.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_annotation.py new file mode 100644 index 0000000..5be9964 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_annotation.py @@ -0,0 +1,1714 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Annotation(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.annotation" + _valid_props = { + "align", + "arrowcolor", + "arrowhead", + "arrowside", + "arrowsize", + "arrowwidth", + "ax", + "axref", + "ay", + "ayref", + "bgcolor", + "bordercolor", + "borderpad", + "borderwidth", + "captureevents", + "clicktoshow", + "font", + "height", + "hoverlabel", + "hovertext", + "name", + "opacity", + "showarrow", + "standoff", + "startarrowhead", + "startarrowsize", + "startstandoff", + "templateitemname", + "text", + "textangle", + "valign", + "visible", + "width", + "x", + "xanchor", + "xclick", + "xref", + "xshift", + "y", + "yanchor", + "yclick", + "yref", + "yshift", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans two or more lines (i.e. `text` + contains one or more
HTML tags) or if an explicit width is + set to override the text width. + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def arrowcolor(self): + """ + Sets the color of the annotation arrow. + + The 'arrowcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["arrowcolor"] + + @arrowcolor.setter + def arrowcolor(self, val): + self["arrowcolor"] = val + + @property + def arrowhead(self): + """ + Sets the end annotation arrow head style. + + The 'arrowhead' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 8] + + Returns + ------- + int + """ + return self["arrowhead"] + + @arrowhead.setter + def arrowhead(self, val): + self["arrowhead"] = val + + @property + def arrowside(self): + """ + Sets the annotation arrow head position. + + The 'arrowside' property is a flaglist and may be specified + as a string containing: + - Any combination of ['end', 'start'] joined with '+' characters + (e.g. 'end+start') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["arrowside"] + + @arrowside.setter + def arrowside(self, val): + self["arrowside"] = val + + @property + def arrowsize(self): + """ + Sets the size of the end annotation arrow head, relative to + `arrowwidth`. A value of 1 (default) gives a head about 3x as + wide as the line. + + The 'arrowsize' property is a number and may be specified as: + - An int or float in the interval [0.3, inf] + + Returns + ------- + int|float + """ + return self["arrowsize"] + + @arrowsize.setter + def arrowsize(self, val): + self["arrowsize"] = val + + @property + def arrowwidth(self): + """ + Sets the width (in px) of annotation arrow line. + + The 'arrowwidth' property is a number and may be specified as: + - An int or float in the interval [0.1, inf] + + Returns + ------- + int|float + """ + return self["arrowwidth"] + + @arrowwidth.setter + def arrowwidth(self, val): + self["arrowwidth"] = val + + @property + def ax(self): + """ + Sets the x component of the arrow tail about the arrow head. If + `axref` is `pixel`, a positive (negative) component corresponds + to an arrow pointing from right to left (left to right). If + `axref` is not `pixel` and is exactly the same as `xref`, this + is an absolute value on that axis, like `x`, specified in the + same coordinates as `xref`. + + The 'ax' property accepts values of any type + + Returns + ------- + Any + """ + return self["ax"] + + @ax.setter + def ax(self, val): + self["ax"] = val + + @property + def axref(self): + """ + Indicates in what coordinates the tail of the annotation + (ax,ay) is specified. If set to a x axis id (e.g. "x" or "x2"), + the `x` position refers to a x coordinate. If set to "paper", + the `x` position refers to the distance from the left of the + plotting area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by "domain" + (separated by a space), the position behaves like for "paper", + but refers to the distance in fractions of the domain length + from the left of the domain of that axis: e.g., *x2 domain* + refers to the domain of the second x axis and a x position of + 0.5 refers to the point between the left and the right of the + domain of the second x axis. In order for absolute positioning + of the arrow to work, "axref" must be exactly the same as + "xref", otherwise "axref" will revert to "pixel" (explained + next). For relative positioning, "axref" can be set to "pixel", + in which case the "ax" value is specified in pixels relative to + "x". Absolute positioning is useful for trendline annotations + which should continue to indicate the correct trend when + zoomed. Relative positioning is useful for specifying the text + offset for an annotated point. + + The 'axref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['pixel'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["axref"] + + @axref.setter + def axref(self, val): + self["axref"] = val + + @property + def ay(self): + """ + Sets the y component of the arrow tail about the arrow head. If + `ayref` is `pixel`, a positive (negative) component corresponds + to an arrow pointing from bottom to top (top to bottom). If + `ayref` is not `pixel` and is exactly the same as `yref`, this + is an absolute value on that axis, like `y`, specified in the + same coordinates as `yref`. + + The 'ay' property accepts values of any type + + Returns + ------- + Any + """ + return self["ay"] + + @ay.setter + def ay(self, val): + self["ay"] = val + + @property + def ayref(self): + """ + Indicates in what coordinates the tail of the annotation + (ax,ay) is specified. If set to a y axis id (e.g. "y" or "y2"), + the `y` position refers to a y coordinate. If set to "paper", + the `y` position refers to the distance from the bottom of the + plotting area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by "domain" + (separated by a space), the position behaves like for "paper", + but refers to the distance in fractions of the domain length + from the bottom of the domain of that axis: e.g., *y2 domain* + refers to the domain of the second y axis and a y position of + 0.5 refers to the point between the bottom and the top of the + domain of the second y axis. In order for absolute positioning + of the arrow to work, "ayref" must be exactly the same as + "yref", otherwise "ayref" will revert to "pixel" (explained + next). For relative positioning, "ayref" can be set to "pixel", + in which case the "ay" value is specified in pixels relative to + "y". Absolute positioning is useful for trendline annotations + which should continue to indicate the correct trend when + zoomed. Relative positioning is useful for specifying the text + offset for an annotated point. + + The 'ayref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['pixel'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["ayref"] + + @ayref.setter + def ayref(self, val): + self["ayref"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the annotation. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the annotation `text`. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderpad(self): + """ + Sets the padding (in px) between the `text` and the enclosing + border. + + The 'borderpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderpad"] + + @borderpad.setter + def borderpad(self, val): + self["borderpad"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the annotation + `text`. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def captureevents(self): + """ + Determines whether the annotation text box captures mouse move + and click events, or allows those events to pass through to + data points in the plot that may be behind the annotation. By + default `captureevents` is False unless `hovertext` is + provided. If you use the event `plotly_clickannotation` without + `hovertext` you must explicitly enable `captureevents`. + + The 'captureevents' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["captureevents"] + + @captureevents.setter + def captureevents(self, val): + self["captureevents"] = val + + @property + def clicktoshow(self): + """ + Makes this annotation respond to clicks on the plot. If you + click a data point that exactly matches the `x` and `y` values + of this annotation, and it is hidden (visible: false), it will + appear. In "onoff" mode, you must click the same point again to + make it disappear, so if you click multiple points, you can + show multiple annotations. In "onout" mode, a click anywhere + else in the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set `xclick` + and/or `yclick`. This is useful for example to label the side + of a bar. To label markers though, `standoff` is preferred over + `xclick` and `yclick`. + + The 'clicktoshow' property is an enumeration that may be specified as: + - One of the following enumeration values: + [False, 'onoff', 'onout'] + + Returns + ------- + Any + """ + return self["clicktoshow"] + + @clicktoshow.setter + def clicktoshow(self, val): + self["clicktoshow"] = val + + @property + def font(self): + """ + Sets the annotation text font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.annotation.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.annotation.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def height(self): + """ + Sets an explicit height for the text box. null (default) lets + the text set the box height. Taller text will be clipped. + + The 'height' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["height"] + + @height.setter + def height(self, val): + self["height"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.annotation.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.layout.annotation.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertext(self): + """ + Sets text to appear when hovering over this annotation. If + omitted or blank, no hover label will appear. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the annotation (text + arrow). + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def showarrow(self): + """ + Determines whether or not the annotation is drawn with an + arrow. If True, `text` is placed near the arrow's tail. If + False, `text` lines up with the `x` and `y` provided. + + The 'showarrow' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showarrow"] + + @showarrow.setter + def showarrow(self, val): + self["showarrow"] = val + + @property + def standoff(self): + """ + Sets a distance, in pixels, to move the end arrowhead away from + the position it is pointing at, for example to point at the + edge of a marker independent of zoom. Note that this shortens + the arrow from the `ax` / `ay` vector, in contrast to `xshift` + / `yshift` which moves everything by this amount. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def startarrowhead(self): + """ + Sets the start annotation arrow head style. + + The 'startarrowhead' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 8] + + Returns + ------- + int + """ + return self["startarrowhead"] + + @startarrowhead.setter + def startarrowhead(self, val): + self["startarrowhead"] = val + + @property + def startarrowsize(self): + """ + Sets the size of the start annotation arrow head, relative to + `arrowwidth`. A value of 1 (default) gives a head about 3x as + wide as the line. + + The 'startarrowsize' property is a number and may be specified as: + - An int or float in the interval [0.3, inf] + + Returns + ------- + int|float + """ + return self["startarrowsize"] + + @startarrowsize.setter + def startarrowsize(self, val): + self["startarrowsize"] = val + + @property + def startstandoff(self): + """ + Sets a distance, in pixels, to move the start arrowhead away + from the position it is pointing at, for example to point at + the edge of a marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, in contrast to + `xshift` / `yshift` which moves everything by this amount. + + The 'startstandoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["startstandoff"] + + @startstandoff.setter + def startstandoff(self, val): + self["startstandoff"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def text(self): + """ + Sets the text associated with this annotation. Plotly uses a + subset of HTML tags to do things like newline (
), bold + (), italics (), hyperlinks (). + Tags , , , , are also supported. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle at which the `text` is drawn with respect to the + horizontal. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def valign(self): + """ + Sets the vertical alignment of the `text` within the box. Has + an effect only if an explicit height is set to override the + text height. + + The 'valign' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["valign"] + + @valign.setter + def valign(self, val): + self["valign"] = val + + @property + def visible(self): + """ + Determines whether or not this annotation is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets an explicit width for the text box. null (default) lets + the text set the box width. Wider text will be clipped. There + is no automatic wrapping; use
to start a new line. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def x(self): + """ + Sets the annotation's x position. If the axis `type` is "log", + then you must take the log of your desired range. If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + + The 'x' property accepts values of any type + + Returns + ------- + Any + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the text box's horizontal position anchor This anchor + binds the `x` position to the "left", "center" or "right" of + the annotation. For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the right-most portion of + the annotation lines up with the right-most edge of the + plotting area. If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is an arrow, + whereas for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xclick(self): + """ + Toggle this annotation when clicking a data point whose `x` + value is `xclick` rather than the annotation's `x` value. + + The 'xclick' property accepts values of any type + + Returns + ------- + Any + """ + return self["xclick"] + + @xclick.setter + def xclick(self, val): + self["xclick"] = val + + @property + def xref(self): + """ + Sets the annotation's x coordinate axis. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x coordinate. + If set to "paper", the `x` position refers to the distance from + the left of the plotting area in normalized coordinates where 0 + (1) corresponds to the left (right). If set to a x axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the left of the domain of + that axis: e.g., *x2 domain* refers to the domain of the second + x axis and a x position of 0.5 refers to the point between the + left and the right of the domain of the second x axis. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def xshift(self): + """ + Shifts the position of the whole annotation and arrow to the + right (positive) or left (negative) by this many pixels. + + The 'xshift' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["xshift"] + + @xshift.setter + def xshift(self, val): + self["xshift"] = val + + @property + def y(self): + """ + Sets the annotation's y position. If the axis `type` is "log", + then you must take the log of your desired range. If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + + The 'y' property accepts values of any type + + Returns + ------- + Any + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the text box's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + annotation. For example, if `y` is set to 1, `yref` to "paper" + and `yanchor` to "top" then the top-most portion of the + annotation lines up with the top-most edge of the plotting + area. If "auto", the anchor is equivalent to "middle" for data- + referenced annotations or if there is an arrow, whereas for + paper-referenced with no arrow, the anchor picked corresponds + to the closest side. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def yclick(self): + """ + Toggle this annotation when clicking a data point whose `y` + value is `yclick` rather than the annotation's `y` value. + + The 'yclick' property accepts values of any type + + Returns + ------- + Any + """ + return self["yclick"] + + @yclick.setter + def yclick(self, val): + self["yclick"] = val + + @property + def yref(self): + """ + Sets the annotation's y coordinate axis. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y coordinate. + If set to "paper", the `y` position refers to the distance from + the bottom of the plotting area in normalized coordinates where + 0 (1) corresponds to the bottom (top). If set to a y axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the domain of + that axis: e.g., *y2 domain* refers to the domain of the second + y axis and a y position of 0.5 refers to the point between the + bottom and the top of the domain of the second y axis. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def yshift(self): + """ + Shifts the position of the whole annotation and arrow up + (positive) or down (negative) by this many pixels. + + The 'yshift' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["yshift"] + + @yshift.setter + def yshift(self, val): + self["yshift"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head. If `axref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from right + to left (left to right). If `axref` is not `pixel` and + is exactly the same as `xref`, this is an absolute + value on that axis, like `x`, specified in the same + coordinates as `xref`. + axref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. In order for absolute + positioning of the arrow to work, "axref" must be + exactly the same as "xref", otherwise "axref" will + revert to "pixel" (explained next). For relative + positioning, "axref" can be set to "pixel", in which + case the "ax" value is specified in pixels relative to + "x". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + ay + Sets the y component of the arrow tail about the arrow + head. If `ayref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from bottom + to top (top to bottom). If `ayref` is not `pixel` and + is exactly the same as `yref`, this is an absolute + value on that axis, like `y`, specified in the same + coordinates as `yref`. + ayref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. In order for absolute + positioning of the arrow to work, "ayref" must be + exactly the same as "yref", otherwise "ayref" will + revert to "pixel" (explained next). For relative + positioning, "ayref" can be set to "pixel", in which + case the "ay" value is specified in pixels relative to + "y". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the plot. If + you click a data point that exactly matches the `x` and + `y` values of this annotation, and it is hidden + (visible: false), it will appear. In "onoff" mode, you + must click the same point again to make it disappear, + so if you click multiple points, you can show multiple + annotations. In "onout" mode, a click anywhere else in + the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for example to + label the side of a bar. To label markers though, + `standoff` is preferred over `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xclick + Toggle this annotation when clicking a data point whose + `x` value is `xclick` rather than the annotation's `x` + value. + xref + Sets the annotation's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yclick + Toggle this annotation when clicking a data point whose + `y` value is `yclick` rather than the annotation's `y` + value. + yref + Sets the annotation's y coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + """ + + def __init__( + self, + arg=None, + align=None, + arrowcolor=None, + arrowhead=None, + arrowside=None, + arrowsize=None, + arrowwidth=None, + ax=None, + axref=None, + ay=None, + ayref=None, + bgcolor=None, + bordercolor=None, + borderpad=None, + borderwidth=None, + captureevents=None, + clicktoshow=None, + font=None, + height=None, + hoverlabel=None, + hovertext=None, + name=None, + opacity=None, + showarrow=None, + standoff=None, + startarrowhead=None, + startarrowsize=None, + startstandoff=None, + templateitemname=None, + text=None, + textangle=None, + valign=None, + visible=None, + width=None, + x=None, + xanchor=None, + xclick=None, + xref=None, + xshift=None, + y=None, + yanchor=None, + yclick=None, + yref=None, + yshift=None, + **kwargs, + ): + """ + Construct a new Annotation object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Annotation` + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head. If `axref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from right + to left (left to right). If `axref` is not `pixel` and + is exactly the same as `xref`, this is an absolute + value on that axis, like `x`, specified in the same + coordinates as `xref`. + axref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. In order for absolute + positioning of the arrow to work, "axref" must be + exactly the same as "xref", otherwise "axref" will + revert to "pixel" (explained next). For relative + positioning, "axref" can be set to "pixel", in which + case the "ax" value is specified in pixels relative to + "x". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + ay + Sets the y component of the arrow tail about the arrow + head. If `ayref` is `pixel`, a positive (negative) + component corresponds to an arrow pointing from bottom + to top (top to bottom). If `ayref` is not `pixel` and + is exactly the same as `yref`, this is an absolute + value on that axis, like `y`, specified in the same + coordinates as `yref`. + ayref + Indicates in what coordinates the tail of the + annotation (ax,ay) is specified. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. In order for absolute + positioning of the arrow to work, "ayref" must be + exactly the same as "yref", otherwise "ayref" will + revert to "pixel" (explained next). For relative + positioning, "ayref" can be set to "pixel", in which + case the "ay" value is specified in pixels relative to + "y". Absolute positioning is useful for trendline + annotations which should continue to indicate the + correct trend when zoomed. Relative positioning is + useful for specifying the text offset for an annotated + point. + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + clicktoshow + Makes this annotation respond to clicks on the plot. If + you click a data point that exactly matches the `x` and + `y` values of this annotation, and it is hidden + (visible: false), it will appear. In "onoff" mode, you + must click the same point again to make it disappear, + so if you click multiple points, you can show multiple + annotations. In "onout" mode, a click anywhere else in + the plot (on another data point or not) will hide this + annotation. If you need to show/hide this annotation in + response to different `x` or `y` values, you can set + `xclick` and/or `yclick`. This is useful for example to + label the side of a bar. To label markers though, + `standoff` is preferred over `xclick` and `yclick`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + :class:`plotly.graph_objects.layout.annotation.Hoverlab + el` instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xclick + Toggle this annotation when clicking a data point whose + `x` value is `xclick` rather than the annotation's `x` + value. + xref + Sets the annotation's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yclick + Toggle this annotation when clicking a data point whose + `y` value is `yclick` rather than the annotation's `y` + value. + yref + Sets the annotation's y coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + + Returns + ------- + Annotation + """ + super().__init__("annotations") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Annotation +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Annotation`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("arrowcolor", arg, arrowcolor) + self._set_property("arrowhead", arg, arrowhead) + self._set_property("arrowside", arg, arrowside) + self._set_property("arrowsize", arg, arrowsize) + self._set_property("arrowwidth", arg, arrowwidth) + self._set_property("ax", arg, ax) + self._set_property("axref", arg, axref) + self._set_property("ay", arg, ay) + self._set_property("ayref", arg, ayref) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderpad", arg, borderpad) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("captureevents", arg, captureevents) + self._set_property("clicktoshow", arg, clicktoshow) + self._set_property("font", arg, font) + self._set_property("height", arg, height) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertext", arg, hovertext) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("showarrow", arg, showarrow) + self._set_property("standoff", arg, standoff) + self._set_property("startarrowhead", arg, startarrowhead) + self._set_property("startarrowsize", arg, startarrowsize) + self._set_property("startstandoff", arg, startstandoff) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("valign", arg, valign) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xclick", arg, xclick) + self._set_property("xref", arg, xref) + self._set_property("xshift", arg, xshift) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("yclick", arg, yclick) + self._set_property("yref", arg, yref) + self._set_property("yshift", arg, yshift) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_coloraxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_coloraxis.py new file mode 100644 index 0000000..4606c7a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_coloraxis.py @@ -0,0 +1,396 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Coloraxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.coloraxis" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "colorbar", + "colorscale", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here corresponding trace color + array(s)) or the bounds set in `cmin` and `cmax` Defaults to + `false` when `cmin` and `cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Value should have the + same units as corresponding trace color array(s) and if set, + `cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `cmin` and/or + `cmax` to be equidistant to this point. Value should have the + same units as corresponding trace color array(s). Has no effect + when `cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Value should have the + same units as corresponding trace color array(s) and if set, + `cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.coloraxis.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.layout.coloraxis.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. If true, `cmin` will + correspond to the last color in the array and `cmax` will + correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here corresponding + trace color array(s)) or the bounds set in `cmin` and + `cmax` Defaults to `false` when `cmin` and `cmax` are + set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as corresponding trace color + array(s) and if set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as corresponding trace + color array(s). Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as corresponding trace color + array(s) and if set, `cmax` must be set as well. + colorbar + :class:`plotly.graph_objects.layout.coloraxis.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + colorbar=None, + colorscale=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Coloraxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Coloraxis` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `colorscale`. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be + chosen according to whether numbers in the `color` + array are all positive, all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here corresponding + trace color array(s)) or the bounds set in `cmin` and + `cmax` Defaults to `false` when `cmin` and `cmax` are + set by the user. + cmax + Sets the upper bound of the color domain. Value should + have the same units as corresponding trace color + array(s) and if set, `cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `cmin` and/or `cmax` to be equidistant to this point. + Value should have the same units as corresponding trace + color array(s). Has no effect when `cauto` is `false`. + cmin + Sets the lower bound of the color domain. Value should + have the same units as corresponding trace color + array(s) and if set, `cmax` must be set as well. + colorbar + :class:`plotly.graph_objects.layout.coloraxis.ColorBar` + instance or dict with compatible properties + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + reversescale + Reverses the color mapping if true. If true, `cmin` + will correspond to the last color in the array and + `cmax` will correspond to the first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. + + Returns + ------- + Coloraxis + """ + super().__init__("coloraxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Coloraxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Coloraxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_colorscale.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_colorscale.py new file mode 100644 index 0000000..b65ed87 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_colorscale.py @@ -0,0 +1,214 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Colorscale(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.colorscale" + _valid_props = {"diverging", "sequential", "sequentialminus"} + + @property + def diverging(self): + """ + Sets the default diverging colorscale. Note that + `autocolorscale` must be true for this attribute to work. + + The 'diverging' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["diverging"] + + @diverging.setter + def diverging(self, val): + self["diverging"] = val + + @property + def sequential(self): + """ + Sets the default sequential colorscale for positive values. + Note that `autocolorscale` must be true for this attribute to + work. + + The 'sequential' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["sequential"] + + @sequential.setter + def sequential(self, val): + self["sequential"] = val + + @property + def sequentialminus(self): + """ + Sets the default sequential colorscale for negative values. + Note that `autocolorscale` must be true for this attribute to + work. + + The 'sequentialminus' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["sequentialminus"] + + @sequentialminus.setter + def sequentialminus(self, val): + self["sequentialminus"] = val + + @property + def _prop_descriptions(self): + return """\ + diverging + Sets the default diverging colorscale. Note that + `autocolorscale` must be true for this attribute to + work. + sequential + Sets the default sequential colorscale for positive + values. Note that `autocolorscale` must be true for + this attribute to work. + sequentialminus + Sets the default sequential colorscale for negative + values. Note that `autocolorscale` must be true for + this attribute to work. + """ + + def __init__( + self, arg=None, diverging=None, sequential=None, sequentialminus=None, **kwargs + ): + """ + Construct a new Colorscale object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Colorscale` + diverging + Sets the default diverging colorscale. Note that + `autocolorscale` must be true for this attribute to + work. + sequential + Sets the default sequential colorscale for positive + values. Note that `autocolorscale` must be true for + this attribute to work. + sequentialminus + Sets the default sequential colorscale for negative + values. Note that `autocolorscale` must be true for + this attribute to work. + + Returns + ------- + Colorscale + """ + super().__init__("colorscale") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Colorscale +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Colorscale`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("diverging", arg, diverging) + self._set_property("sequential", arg, sequential) + self._set_property("sequentialminus", arg, sequentialminus) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_font.py new file mode 100644 index 0000000..c691e70 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the global font. Note that fonts used in traces and other + layout components inherit from the global font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_geo.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_geo.py new file mode 100644 index 0000000..40fba3a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_geo.py @@ -0,0 +1,968 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Geo(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.geo" + _valid_props = { + "bgcolor", + "center", + "coastlinecolor", + "coastlinewidth", + "countrycolor", + "countrywidth", + "domain", + "fitbounds", + "framecolor", + "framewidth", + "lakecolor", + "landcolor", + "lataxis", + "lonaxis", + "oceancolor", + "projection", + "resolution", + "rivercolor", + "riverwidth", + "scope", + "showcoastlines", + "showcountries", + "showframe", + "showlakes", + "showland", + "showocean", + "showrivers", + "showsubunits", + "subunitcolor", + "subunitwidth", + "uirevision", + "visible", + } + + @property + def bgcolor(self): + """ + Set the background color of the map + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def center(self): + """ + The 'center' property is an instance of Center + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.geo.Center` + - A dict of string/value properties that will be passed + to the Center constructor + + Returns + ------- + plotly.graph_objs.layout.geo.Center + """ + return self["center"] + + @center.setter + def center(self, val): + self["center"] = val + + @property + def coastlinecolor(self): + """ + Sets the coastline color. + + The 'coastlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["coastlinecolor"] + + @coastlinecolor.setter + def coastlinecolor(self, val): + self["coastlinecolor"] = val + + @property + def coastlinewidth(self): + """ + Sets the coastline stroke width (in px). + + The 'coastlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["coastlinewidth"] + + @coastlinewidth.setter + def coastlinewidth(self, val): + self["coastlinewidth"] = val + + @property + def countrycolor(self): + """ + Sets line color of the country boundaries. + + The 'countrycolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["countrycolor"] + + @countrycolor.setter + def countrycolor(self, val): + self["countrycolor"] = val + + @property + def countrywidth(self): + """ + Sets line width (in px) of the country boundaries. + + The 'countrywidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["countrywidth"] + + @countrywidth.setter + def countrywidth(self, val): + self["countrywidth"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.geo.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.geo.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def fitbounds(self): + """ + Determines if this subplot's view settings are auto-computed to + fit trace data. On scoped maps, setting `fitbounds` leads to + `center.lon` and `center.lat` getting auto-filled. On maps with + a non-clipped projection, setting `fitbounds` leads to + `center.lon`, `center.lat`, and `projection.rotation.lon` + getting auto-filled. On maps with a clipped projection, setting + `fitbounds` leads to `center.lon`, `center.lat`, + `projection.rotation.lon`, `projection.rotation.lat`, + `lonaxis.range` and `lataxis.range` getting auto-filled. If + "locations", only the trace's visible locations are considered + in the `fitbounds` computations. If "geojson", the entire trace + input `geojson` (if provided) is considered in the `fitbounds` + computations, Defaults to False. + + The 'fitbounds' property is an enumeration that may be specified as: + - One of the following enumeration values: + [False, 'locations', 'geojson'] + + Returns + ------- + Any + """ + return self["fitbounds"] + + @fitbounds.setter + def fitbounds(self, val): + self["fitbounds"] = val + + @property + def framecolor(self): + """ + Sets the color the frame. + + The 'framecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["framecolor"] + + @framecolor.setter + def framecolor(self, val): + self["framecolor"] = val + + @property + def framewidth(self): + """ + Sets the stroke width (in px) of the frame. + + The 'framewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["framewidth"] + + @framewidth.setter + def framewidth(self, val): + self["framewidth"] = val + + @property + def lakecolor(self): + """ + Sets the color of the lakes. + + The 'lakecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["lakecolor"] + + @lakecolor.setter + def lakecolor(self, val): + self["lakecolor"] = val + + @property + def landcolor(self): + """ + Sets the land mass color. + + The 'landcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["landcolor"] + + @landcolor.setter + def landcolor(self, val): + self["landcolor"] = val + + @property + def lataxis(self): + """ + The 'lataxis' property is an instance of Lataxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.geo.Lataxis` + - A dict of string/value properties that will be passed + to the Lataxis constructor + + Returns + ------- + plotly.graph_objs.layout.geo.Lataxis + """ + return self["lataxis"] + + @lataxis.setter + def lataxis(self, val): + self["lataxis"] = val + + @property + def lonaxis(self): + """ + The 'lonaxis' property is an instance of Lonaxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.geo.Lonaxis` + - A dict of string/value properties that will be passed + to the Lonaxis constructor + + Returns + ------- + plotly.graph_objs.layout.geo.Lonaxis + """ + return self["lonaxis"] + + @lonaxis.setter + def lonaxis(self, val): + self["lonaxis"] = val + + @property + def oceancolor(self): + """ + Sets the ocean color + + The 'oceancolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["oceancolor"] + + @oceancolor.setter + def oceancolor(self, val): + self["oceancolor"] = val + + @property + def projection(self): + """ + The 'projection' property is an instance of Projection + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.geo.Projection` + - A dict of string/value properties that will be passed + to the Projection constructor + + Returns + ------- + plotly.graph_objs.layout.geo.Projection + """ + return self["projection"] + + @projection.setter + def projection(self, val): + self["projection"] = val + + @property + def resolution(self): + """ + Sets the resolution of the base layers. The values have units + of km/mm e.g. 110 corresponds to a scale ratio of + 1:110,000,000. + + The 'resolution' property is an enumeration that may be specified as: + - One of the following enumeration values: + [110, 50] + + Returns + ------- + Any + """ + return self["resolution"] + + @resolution.setter + def resolution(self, val): + self["resolution"] = val + + @property + def rivercolor(self): + """ + Sets color of the rivers. + + The 'rivercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["rivercolor"] + + @rivercolor.setter + def rivercolor(self, val): + self["rivercolor"] = val + + @property + def riverwidth(self): + """ + Sets the stroke width (in px) of the rivers. + + The 'riverwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["riverwidth"] + + @riverwidth.setter + def riverwidth(self, val): + self["riverwidth"] = val + + @property + def scope(self): + """ + Set the scope of the map. + + The 'scope' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['africa', 'asia', 'europe', 'north america', 'south + america', 'usa', 'world'] + + Returns + ------- + Any + """ + return self["scope"] + + @scope.setter + def scope(self, val): + self["scope"] = val + + @property + def showcoastlines(self): + """ + Sets whether or not the coastlines are drawn. + + The 'showcoastlines' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showcoastlines"] + + @showcoastlines.setter + def showcoastlines(self, val): + self["showcoastlines"] = val + + @property + def showcountries(self): + """ + Sets whether or not country boundaries are drawn. + + The 'showcountries' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showcountries"] + + @showcountries.setter + def showcountries(self, val): + self["showcountries"] = val + + @property + def showframe(self): + """ + Sets whether or not a frame is drawn around the map. + + The 'showframe' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showframe"] + + @showframe.setter + def showframe(self, val): + self["showframe"] = val + + @property + def showlakes(self): + """ + Sets whether or not lakes are drawn. + + The 'showlakes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlakes"] + + @showlakes.setter + def showlakes(self, val): + self["showlakes"] = val + + @property + def showland(self): + """ + Sets whether or not land masses are filled in color. + + The 'showland' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showland"] + + @showland.setter + def showland(self, val): + self["showland"] = val + + @property + def showocean(self): + """ + Sets whether or not oceans are filled in color. + + The 'showocean' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showocean"] + + @showocean.setter + def showocean(self, val): + self["showocean"] = val + + @property + def showrivers(self): + """ + Sets whether or not rivers are drawn. + + The 'showrivers' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showrivers"] + + @showrivers.setter + def showrivers(self, val): + self["showrivers"] = val + + @property + def showsubunits(self): + """ + Sets whether or not boundaries of subunits within countries + (e.g. states, provinces) are drawn. + + The 'showsubunits' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showsubunits"] + + @showsubunits.setter + def showsubunits(self, val): + self["showsubunits"] = val + + @property + def subunitcolor(self): + """ + Sets the color of the subunits boundaries. + + The 'subunitcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["subunitcolor"] + + @subunitcolor.setter + def subunitcolor(self, val): + self["subunitcolor"] = val + + @property + def subunitwidth(self): + """ + Sets the stroke width (in px) of the subunits boundaries. + + The 'subunitwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["subunitwidth"] + + @subunitwidth.setter + def subunitwidth(self, val): + self["subunitwidth"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in the view + (projection and center). Defaults to `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + Sets the default visibility of the base layers. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Set the background color of the map + center + :class:`plotly.graph_objects.layout.geo.Center` + instance or dict with compatible properties + coastlinecolor + Sets the coastline color. + coastlinewidth + Sets the coastline stroke width (in px). + countrycolor + Sets line color of the country boundaries. + countrywidth + Sets line width (in px) of the country boundaries. + domain + :class:`plotly.graph_objects.layout.geo.Domain` + instance or dict with compatible properties + fitbounds + Determines if this subplot's view settings are auto- + computed to fit trace data. On scoped maps, setting + `fitbounds` leads to `center.lon` and `center.lat` + getting auto-filled. On maps with a non-clipped + projection, setting `fitbounds` leads to `center.lon`, + `center.lat`, and `projection.rotation.lon` getting + auto-filled. On maps with a clipped projection, setting + `fitbounds` leads to `center.lon`, `center.lat`, + `projection.rotation.lon`, `projection.rotation.lat`, + `lonaxis.range` and `lataxis.range` getting auto- + filled. If "locations", only the trace's visible + locations are considered in the `fitbounds` + computations. If "geojson", the entire trace input + `geojson` (if provided) is considered in the + `fitbounds` computations, Defaults to False. + framecolor + Sets the color the frame. + framewidth + Sets the stroke width (in px) of the frame. + lakecolor + Sets the color of the lakes. + landcolor + Sets the land mass color. + lataxis + :class:`plotly.graph_objects.layout.geo.Lataxis` + instance or dict with compatible properties + lonaxis + :class:`plotly.graph_objects.layout.geo.Lonaxis` + instance or dict with compatible properties + oceancolor + Sets the ocean color + projection + :class:`plotly.graph_objects.layout.geo.Projection` + instance or dict with compatible properties + resolution + Sets the resolution of the base layers. The values have + units of km/mm e.g. 110 corresponds to a scale ratio of + 1:110,000,000. + rivercolor + Sets color of the rivers. + riverwidth + Sets the stroke width (in px) of the rivers. + scope + Set the scope of the map. + showcoastlines + Sets whether or not the coastlines are drawn. + showcountries + Sets whether or not country boundaries are drawn. + showframe + Sets whether or not a frame is drawn around the map. + showlakes + Sets whether or not lakes are drawn. + showland + Sets whether or not land masses are filled in color. + showocean + Sets whether or not oceans are filled in color. + showrivers + Sets whether or not rivers are drawn. + showsubunits + Sets whether or not boundaries of subunits within + countries (e.g. states, provinces) are drawn. + subunitcolor + Sets the color of the subunits boundaries. + subunitwidth + Sets the stroke width (in px) of the subunits + boundaries. + uirevision + Controls persistence of user-driven changes in the view + (projection and center). Defaults to + `layout.uirevision`. + visible + Sets the default visibility of the base layers. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + center=None, + coastlinecolor=None, + coastlinewidth=None, + countrycolor=None, + countrywidth=None, + domain=None, + fitbounds=None, + framecolor=None, + framewidth=None, + lakecolor=None, + landcolor=None, + lataxis=None, + lonaxis=None, + oceancolor=None, + projection=None, + resolution=None, + rivercolor=None, + riverwidth=None, + scope=None, + showcoastlines=None, + showcountries=None, + showframe=None, + showlakes=None, + showland=None, + showocean=None, + showrivers=None, + showsubunits=None, + subunitcolor=None, + subunitwidth=None, + uirevision=None, + visible=None, + **kwargs, + ): + """ + Construct a new Geo object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Geo` + bgcolor + Set the background color of the map + center + :class:`plotly.graph_objects.layout.geo.Center` + instance or dict with compatible properties + coastlinecolor + Sets the coastline color. + coastlinewidth + Sets the coastline stroke width (in px). + countrycolor + Sets line color of the country boundaries. + countrywidth + Sets line width (in px) of the country boundaries. + domain + :class:`plotly.graph_objects.layout.geo.Domain` + instance or dict with compatible properties + fitbounds + Determines if this subplot's view settings are auto- + computed to fit trace data. On scoped maps, setting + `fitbounds` leads to `center.lon` and `center.lat` + getting auto-filled. On maps with a non-clipped + projection, setting `fitbounds` leads to `center.lon`, + `center.lat`, and `projection.rotation.lon` getting + auto-filled. On maps with a clipped projection, setting + `fitbounds` leads to `center.lon`, `center.lat`, + `projection.rotation.lon`, `projection.rotation.lat`, + `lonaxis.range` and `lataxis.range` getting auto- + filled. If "locations", only the trace's visible + locations are considered in the `fitbounds` + computations. If "geojson", the entire trace input + `geojson` (if provided) is considered in the + `fitbounds` computations, Defaults to False. + framecolor + Sets the color the frame. + framewidth + Sets the stroke width (in px) of the frame. + lakecolor + Sets the color of the lakes. + landcolor + Sets the land mass color. + lataxis + :class:`plotly.graph_objects.layout.geo.Lataxis` + instance or dict with compatible properties + lonaxis + :class:`plotly.graph_objects.layout.geo.Lonaxis` + instance or dict with compatible properties + oceancolor + Sets the ocean color + projection + :class:`plotly.graph_objects.layout.geo.Projection` + instance or dict with compatible properties + resolution + Sets the resolution of the base layers. The values have + units of km/mm e.g. 110 corresponds to a scale ratio of + 1:110,000,000. + rivercolor + Sets color of the rivers. + riverwidth + Sets the stroke width (in px) of the rivers. + scope + Set the scope of the map. + showcoastlines + Sets whether or not the coastlines are drawn. + showcountries + Sets whether or not country boundaries are drawn. + showframe + Sets whether or not a frame is drawn around the map. + showlakes + Sets whether or not lakes are drawn. + showland + Sets whether or not land masses are filled in color. + showocean + Sets whether or not oceans are filled in color. + showrivers + Sets whether or not rivers are drawn. + showsubunits + Sets whether or not boundaries of subunits within + countries (e.g. states, provinces) are drawn. + subunitcolor + Sets the color of the subunits boundaries. + subunitwidth + Sets the stroke width (in px) of the subunits + boundaries. + uirevision + Controls persistence of user-driven changes in the view + (projection and center). Defaults to + `layout.uirevision`. + visible + Sets the default visibility of the base layers. + + Returns + ------- + Geo + """ + super().__init__("geo") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Geo +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Geo`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("center", arg, center) + self._set_property("coastlinecolor", arg, coastlinecolor) + self._set_property("coastlinewidth", arg, coastlinewidth) + self._set_property("countrycolor", arg, countrycolor) + self._set_property("countrywidth", arg, countrywidth) + self._set_property("domain", arg, domain) + self._set_property("fitbounds", arg, fitbounds) + self._set_property("framecolor", arg, framecolor) + self._set_property("framewidth", arg, framewidth) + self._set_property("lakecolor", arg, lakecolor) + self._set_property("landcolor", arg, landcolor) + self._set_property("lataxis", arg, lataxis) + self._set_property("lonaxis", arg, lonaxis) + self._set_property("oceancolor", arg, oceancolor) + self._set_property("projection", arg, projection) + self._set_property("resolution", arg, resolution) + self._set_property("rivercolor", arg, rivercolor) + self._set_property("riverwidth", arg, riverwidth) + self._set_property("scope", arg, scope) + self._set_property("showcoastlines", arg, showcoastlines) + self._set_property("showcountries", arg, showcountries) + self._set_property("showframe", arg, showframe) + self._set_property("showlakes", arg, showlakes) + self._set_property("showland", arg, showland) + self._set_property("showocean", arg, showocean) + self._set_property("showrivers", arg, showrivers) + self._set_property("showsubunits", arg, showsubunits) + self._set_property("subunitcolor", arg, subunitcolor) + self._set_property("subunitwidth", arg, subunitwidth) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_grid.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_grid.py new file mode 100644 index 0000000..8788027 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_grid.py @@ -0,0 +1,511 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Grid(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.grid" + _valid_props = { + "columns", + "domain", + "pattern", + "roworder", + "rows", + "subplots", + "xaxes", + "xgap", + "xside", + "yaxes", + "ygap", + "yside", + } + + @property + def columns(self): + """ + The number of columns in the grid. If you provide a 2D + `subplots` array, the length of its longest row is used as the + default. If you give an `xaxes` array, its length is used as + the default. But it's also possible to have a different length, + if you want to leave a row at the end for non-cartesian + subplots. + + The 'columns' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["columns"] + + @columns.setter + def columns(self, val): + self["columns"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.grid.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.grid.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def pattern(self): + """ + If no `subplots`, `xaxes`, or `yaxes` are given but we do have + `rows` and `columns`, we can generate defaults using + consecutive axis IDs, in two ways: "coupled" gives one x axis + per column and one y axis per row. "independent" uses a new xy + pair for each cell, left-to-right across each row then + iterating rows according to `roworder`. + + The 'pattern' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['independent', 'coupled'] + + Returns + ------- + Any + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def roworder(self): + """ + Is the first row the top or the bottom? Note that columns are + always enumerated from left to right. + + The 'roworder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top to bottom', 'bottom to top'] + + Returns + ------- + Any + """ + return self["roworder"] + + @roworder.setter + def roworder(self, val): + self["roworder"] = val + + @property + def rows(self): + """ + The number of rows in the grid. If you provide a 2D `subplots` + array or a `yaxes` array, its length is used as the default. + But it's also possible to have a different length, if you want + to leave a row at the end for non-cartesian subplots. + + The 'rows' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["rows"] + + @rows.setter + def rows(self, val): + self["rows"] = val + + @property + def subplots(self): + """ + Used for freeform grids, where some axes may be shared across + subplots but others are not. Each entry should be a cartesian + subplot id, like "xy" or "x3y2", or "" to leave that cell + empty. You may reuse x axes within the same column, and y axes + within the same row. Non-cartesian subplots and traces that + support `domain` can place themselves in this grid separately + using the `gridcell` attribute. + + The 'subplots' property is an info array that may be specified as: + * a 2D list where: + The 'subplots[i][j]' property is an enumeration that may be specified as: + - One of the following enumeration values: + [''] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?y([2-9]|[1-9][0-9]+)?$'] + + Returns + ------- + list + """ + return self["subplots"] + + @subplots.setter + def subplots(self, val): + self["subplots"] = val + + @property + def xaxes(self): + """ + Used with `yaxes` when the x and y axes are shared across + columns and rows. Each entry should be an x axis id like "x", + "x2", etc., or "" to not put an x axis in that column. Entries + other than "" must be unique. Ignored if `subplots` is present. + If missing but `yaxes` is present, will generate consecutive + IDs. + + The 'xaxes' property is an info array that may be specified as: + * a list of elements where: + The 'xaxes[i]' property is an enumeration that may be specified as: + - One of the following enumeration values: + [''] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + list + """ + return self["xaxes"] + + @xaxes.setter + def xaxes(self, val): + self["xaxes"] = val + + @property + def xgap(self): + """ + Horizontal space between grid cells, expressed as a fraction of + the total width available to one cell. Defaults to 0.1 for + coupled-axes grids and 0.2 for independent grids. + + The 'xgap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["xgap"] + + @xgap.setter + def xgap(self, val): + self["xgap"] = val + + @property + def xside(self): + """ + Sets where the x axis labels and titles go. "bottom" means the + very bottom of the grid. "bottom plot" is the lowest plot that + each x axis is used in. "top" and "top plot" are similar. + + The 'xside' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['bottom', 'bottom plot', 'top plot', 'top'] + + Returns + ------- + Any + """ + return self["xside"] + + @xside.setter + def xside(self, val): + self["xside"] = val + + @property + def yaxes(self): + """ + Used with `yaxes` when the x and y axes are shared across + columns and rows. Each entry should be an y axis id like "y", + "y2", etc., or "" to not put a y axis in that row. Entries + other than "" must be unique. Ignored if `subplots` is present. + If missing but `xaxes` is present, will generate consecutive + IDs. + + The 'yaxes' property is an info array that may be specified as: + * a list of elements where: + The 'yaxes[i]' property is an enumeration that may be specified as: + - One of the following enumeration values: + [''] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + list + """ + return self["yaxes"] + + @yaxes.setter + def yaxes(self, val): + self["yaxes"] = val + + @property + def ygap(self): + """ + Vertical space between grid cells, expressed as a fraction of + the total height available to one cell. Defaults to 0.1 for + coupled-axes grids and 0.3 for independent grids. + + The 'ygap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ygap"] + + @ygap.setter + def ygap(self, val): + self["ygap"] = val + + @property + def yside(self): + """ + Sets where the y axis labels and titles go. "left" means the + very left edge of the grid. *left plot* is the leftmost plot + that each y axis is used in. "right" and *right plot* are + similar. + + The 'yside' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'left plot', 'right plot', 'right'] + + Returns + ------- + Any + """ + return self["yside"] + + @yside.setter + def yside(self, val): + self["yside"] = val + + @property + def _prop_descriptions(self): + return """\ + columns + The number of columns in the grid. If you provide a 2D + `subplots` array, the length of its longest row is used + as the default. If you give an `xaxes` array, its + length is used as the default. But it's also possible + to have a different length, if you want to leave a row + at the end for non-cartesian subplots. + domain + :class:`plotly.graph_objects.layout.grid.Domain` + instance or dict with compatible properties + pattern + If no `subplots`, `xaxes`, or `yaxes` are given but we + do have `rows` and `columns`, we can generate defaults + using consecutive axis IDs, in two ways: "coupled" + gives one x axis per column and one y axis per row. + "independent" uses a new xy pair for each cell, left- + to-right across each row then iterating rows according + to `roworder`. + roworder + Is the first row the top or the bottom? Note that + columns are always enumerated from left to right. + rows + The number of rows in the grid. If you provide a 2D + `subplots` array or a `yaxes` array, its length is used + as the default. But it's also possible to have a + different length, if you want to leave a row at the end + for non-cartesian subplots. + subplots + Used for freeform grids, where some axes may be shared + across subplots but others are not. Each entry should + be a cartesian subplot id, like "xy" or "x3y2", or "" + to leave that cell empty. You may reuse x axes within + the same column, and y axes within the same row. Non- + cartesian subplots and traces that support `domain` can + place themselves in this grid separately using the + `gridcell` attribute. + xaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an x axis + id like "x", "x2", etc., or "" to not put an x axis in + that column. Entries other than "" must be unique. + Ignored if `subplots` is present. If missing but + `yaxes` is present, will generate consecutive IDs. + xgap + Horizontal space between grid cells, expressed as a + fraction of the total width available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.2 for + independent grids. + xside + Sets where the x axis labels and titles go. "bottom" + means the very bottom of the grid. "bottom plot" is the + lowest plot that each x axis is used in. "top" and "top + plot" are similar. + yaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an y axis + id like "y", "y2", etc., or "" to not put a y axis in + that row. Entries other than "" must be unique. Ignored + if `subplots` is present. If missing but `xaxes` is + present, will generate consecutive IDs. + ygap + Vertical space between grid cells, expressed as a + fraction of the total height available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.3 for + independent grids. + yside + Sets where the y axis labels and titles go. "left" + means the very left edge of the grid. *left plot* is + the leftmost plot that each y axis is used in. "right" + and *right plot* are similar. + """ + + def __init__( + self, + arg=None, + columns=None, + domain=None, + pattern=None, + roworder=None, + rows=None, + subplots=None, + xaxes=None, + xgap=None, + xside=None, + yaxes=None, + ygap=None, + yside=None, + **kwargs, + ): + """ + Construct a new Grid object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Grid` + columns + The number of columns in the grid. If you provide a 2D + `subplots` array, the length of its longest row is used + as the default. If you give an `xaxes` array, its + length is used as the default. But it's also possible + to have a different length, if you want to leave a row + at the end for non-cartesian subplots. + domain + :class:`plotly.graph_objects.layout.grid.Domain` + instance or dict with compatible properties + pattern + If no `subplots`, `xaxes`, or `yaxes` are given but we + do have `rows` and `columns`, we can generate defaults + using consecutive axis IDs, in two ways: "coupled" + gives one x axis per column and one y axis per row. + "independent" uses a new xy pair for each cell, left- + to-right across each row then iterating rows according + to `roworder`. + roworder + Is the first row the top or the bottom? Note that + columns are always enumerated from left to right. + rows + The number of rows in the grid. If you provide a 2D + `subplots` array or a `yaxes` array, its length is used + as the default. But it's also possible to have a + different length, if you want to leave a row at the end + for non-cartesian subplots. + subplots + Used for freeform grids, where some axes may be shared + across subplots but others are not. Each entry should + be a cartesian subplot id, like "xy" or "x3y2", or "" + to leave that cell empty. You may reuse x axes within + the same column, and y axes within the same row. Non- + cartesian subplots and traces that support `domain` can + place themselves in this grid separately using the + `gridcell` attribute. + xaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an x axis + id like "x", "x2", etc., or "" to not put an x axis in + that column. Entries other than "" must be unique. + Ignored if `subplots` is present. If missing but + `yaxes` is present, will generate consecutive IDs. + xgap + Horizontal space between grid cells, expressed as a + fraction of the total width available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.2 for + independent grids. + xside + Sets where the x axis labels and titles go. "bottom" + means the very bottom of the grid. "bottom plot" is the + lowest plot that each x axis is used in. "top" and "top + plot" are similar. + yaxes + Used with `yaxes` when the x and y axes are shared + across columns and rows. Each entry should be an y axis + id like "y", "y2", etc., or "" to not put a y axis in + that row. Entries other than "" must be unique. Ignored + if `subplots` is present. If missing but `xaxes` is + present, will generate consecutive IDs. + ygap + Vertical space between grid cells, expressed as a + fraction of the total height available to one cell. + Defaults to 0.1 for coupled-axes grids and 0.3 for + independent grids. + yside + Sets where the y axis labels and titles go. "left" + means the very left edge of the grid. *left plot* is + the leftmost plot that each y axis is used in. "right" + and *right plot* are similar. + + Returns + ------- + Grid + """ + super().__init__("grid") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Grid +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Grid`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("columns", arg, columns) + self._set_property("domain", arg, domain) + self._set_property("pattern", arg, pattern) + self._set_property("roworder", arg, roworder) + self._set_property("rows", arg, rows) + self._set_property("subplots", arg, subplots) + self._set_property("xaxes", arg, xaxes) + self._set_property("xgap", arg, xgap) + self._set_property("xside", arg, xside) + self._set_property("yaxes", arg, yaxes) + self._set_property("ygap", arg, ygap) + self._set_property("yside", arg, yside) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_hoverlabel.py new file mode 100644 index 0000000..867d356 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_hoverlabel.py @@ -0,0 +1,254 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.hoverlabel" + _valid_props = { + "align", + "bgcolor", + "bordercolor", + "font", + "grouptitlefont", + "namelength", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + + Returns + ------- + Any + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def bgcolor(self): + """ + Sets the background color of all hover labels on graph + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the border color of all hover labels on graph. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def font(self): + """ + Sets the default hover label font used by all traces on the + graph. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def grouptitlefont(self): + """ + Sets the font for group titles in hover (unified modes). + Defaults to `hoverlabel.font`. + + The 'grouptitlefont' property is an instance of Grouptitlefont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.hoverlabel.Grouptitlefont` + - A dict of string/value properties that will be passed + to the Grouptitlefont constructor + + Returns + ------- + plotly.graph_objs.layout.hoverlabel.Grouptitlefont + """ + return self["grouptitlefont"] + + @grouptitlefont.setter + def grouptitlefont(self, val): + self["grouptitlefont"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + + Returns + ------- + int + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + bgcolor + Sets the background color of all hover labels on graph + bordercolor + Sets the border color of all hover labels on graph. + font + Sets the default hover label font used by all traces on + the graph. + grouptitlefont + Sets the font for group titles in hover (unified + modes). Defaults to `hoverlabel.font`. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + """ + + def __init__( + self, + arg=None, + align=None, + bgcolor=None, + bordercolor=None, + font=None, + grouptitlefont=None, + namelength=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + bgcolor + Sets the background color of all hover labels on graph + bordercolor + Sets the border color of all hover labels on graph. + font + Sets the default hover label font used by all traces on + the graph. + grouptitlefont + Sets the font for group titles in hover (unified + modes). Defaults to `hoverlabel.font`. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("font", arg, font) + self._set_property("grouptitlefont", arg, grouptitlefont) + self._set_property("namelength", arg, namelength) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_image.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_image.py new file mode 100644 index 0000000..33865e4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_image.py @@ -0,0 +1,608 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Image(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.image" + _valid_props = { + "layer", + "name", + "opacity", + "sizex", + "sizey", + "sizing", + "source", + "templateitemname", + "visible", + "x", + "xanchor", + "xref", + "y", + "yanchor", + "yref", + } + + @property + def layer(self): + """ + Specifies whether images are drawn below or above traces. When + `xref` and `yref` are both set to `paper`, image is drawn below + the entire plot area. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['below', 'above'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the image. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def sizex(self): + """ + Sets the image container size horizontally. The image will be + sized based on the `position` value. When `xref` is set to + `paper`, units are sized relative to the plot width. When + `xref` ends with ` domain`, units are sized relative to the + axis width. + + The 'sizex' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizex"] + + @sizex.setter + def sizex(self, val): + self["sizex"] = val + + @property + def sizey(self): + """ + Sets the image container size vertically. The image will be + sized based on the `position` value. When `yref` is set to + `paper`, units are sized relative to the plot height. When + `yref` ends with ` domain`, units are sized relative to the + axis height. + + The 'sizey' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizey"] + + @sizey.setter + def sizey(self, val): + self["sizey"] = val + + @property + def sizing(self): + """ + Specifies which dimension of the image to constrain. + + The 'sizing' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fill', 'contain', 'stretch'] + + Returns + ------- + Any + """ + return self["sizing"] + + @sizing.setter + def sizing(self, val): + self["sizing"] = val + + @property + def source(self): + """ + Specifies the URL of the image to be used. The URL must be + accessible from the domain where the plot code is run, and can + be either relative or absolute. + + The 'source' property is an image URI that may be specified as: + - A remote image URI string + (e.g. 'http://www.somewhere.com/image.png') + - A data URI image string + (e.g. 'data:image/png;base64,iVBORw0KGgoAAAANSU') + - A PIL.Image.Image object which will be immediately converted + to a data URI image string + See http://pillow.readthedocs.io/en/latest/reference/Image.html + + Returns + ------- + str + """ + return self["source"] + + @source.setter + def source(self, val): + self["source"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def visible(self): + """ + Determines whether or not this image is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the image's x position. When `xref` is set to `paper`, + units are sized relative to the plot height. See `xref` for + more info + + The 'x' property accepts values of any type + + Returns + ------- + Any + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the anchor for the x position + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xref(self): + """ + Sets the images's x coordinate axis. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x coordinate. + If set to "paper", the `x` position refers to the distance from + the left of the plotting area in normalized coordinates where 0 + (1) corresponds to the left (right). If set to a x axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the left of the domain of + that axis: e.g., *x2 domain* refers to the domain of the second + x axis and a x position of 0.5 refers to the point between the + left and the right of the domain of the second x axis. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the image's y position. When `yref` is set to `paper`, + units are sized relative to the plot height. See `yref` for + more info + + The 'y' property accepts values of any type + + Returns + ------- + Any + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the anchor for the y position. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def yref(self): + """ + Sets the images's y coordinate axis. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y coordinate. + If set to "paper", the `y` position refers to the distance from + the bottom of the plotting area in normalized coordinates where + 0 (1) corresponds to the bottom (top). If set to a y axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the domain of + that axis: e.g., *y2 domain* refers to the domain of the second + y axis and a y position of 0.5 refers to the point between the + bottom and the top of the domain of the second y axis. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + layer + Specifies whether images are drawn below or above + traces. When `xref` and `yref` are both set to `paper`, + image is drawn below the entire plot area. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The image + will be sized based on the `position` value. When + `xref` is set to `paper`, units are sized relative to + the plot width. When `xref` ends with ` domain`, units + are sized relative to the axis width. + sizey + Sets the image container size vertically. The image + will be sized based on the `position` value. When + `yref` is set to `paper`, units are sized relative to + the plot height. When `yref` ends with ` domain`, units + are sized relative to the axis height. + sizing + Specifies which dimension of the image to constrain. + source + Specifies the URL of the image to be used. The URL must + be accessible from the domain where the plot code is + run, and can be either relative or absolute. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this image is visible. + x + Sets the image's x position. When `xref` is set to + `paper`, units are sized relative to the plot height. + See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y + Sets the image's y position. When `yref` is set to + `paper`, units are sized relative to the plot height. + See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + """ + + def __init__( + self, + arg=None, + layer=None, + name=None, + opacity=None, + sizex=None, + sizey=None, + sizing=None, + source=None, + templateitemname=None, + visible=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + **kwargs, + ): + """ + Construct a new Image object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Image` + layer + Specifies whether images are drawn below or above + traces. When `xref` and `yref` are both set to `paper`, + image is drawn below the entire plot area. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the image. + sizex + Sets the image container size horizontally. The image + will be sized based on the `position` value. When + `xref` is set to `paper`, units are sized relative to + the plot width. When `xref` ends with ` domain`, units + are sized relative to the axis width. + sizey + Sets the image container size vertically. The image + will be sized based on the `position` value. When + `yref` is set to `paper`, units are sized relative to + the plot height. When `yref` ends with ` domain`, units + are sized relative to the axis height. + sizing + Specifies which dimension of the image to constrain. + source + Specifies the URL of the image to be used. The URL must + be accessible from the domain where the plot code is + run, and can be either relative or absolute. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this image is visible. + x + Sets the image's x position. When `xref` is set to + `paper`, units are sized relative to the plot height. + See `xref` for more info + xanchor + Sets the anchor for the x position + xref + Sets the images's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y + Sets the image's y position. When `yref` is set to + `paper`, units are sized relative to the plot height. + See `yref` for more info + yanchor + Sets the anchor for the y position. + yref + Sets the images's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + + Returns + ------- + Image + """ + super().__init__("images") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Image +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Image`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("layer", arg, layer) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("sizex", arg, sizex) + self._set_property("sizey", arg, sizey) + self._set_property("sizing", arg, sizing) + self._set_property("source", arg, source) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_legend.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_legend.py new file mode 100644 index 0000000..7df6dad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_legend.py @@ -0,0 +1,916 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Legend(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.legend" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "entrywidth", + "entrywidthmode", + "font", + "groupclick", + "grouptitlefont", + "indentation", + "itemclick", + "itemdoubleclick", + "itemsizing", + "itemwidth", + "orientation", + "title", + "tracegroupgap", + "traceorder", + "uirevision", + "valign", + "visible", + "x", + "xanchor", + "xref", + "y", + "yanchor", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the legend background color. Defaults to + `layout.paper_bgcolor`. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the legend. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the legend. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def entrywidth(self): + """ + Sets the width (in px or fraction) of the legend. Use 0 to size + the entry based on the text width, when `entrywidthmode` is set + to "pixels". + + The 'entrywidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["entrywidth"] + + @entrywidth.setter + def entrywidth(self, val): + self["entrywidth"] = val + + @property + def entrywidthmode(self): + """ + Determines what entrywidth means. + + The 'entrywidthmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["entrywidthmode"] + + @entrywidthmode.setter + def entrywidthmode(self, val): + self["entrywidthmode"] = val + + @property + def font(self): + """ + Sets the font used to text the legend items. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.legend.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.legend.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def groupclick(self): + """ + Determines the behavior on legend group item click. + "toggleitem" toggles the visibility of the individual item + clicked on the graph. "togglegroup" toggles the visibility of + all items in the same legendgroup as the item clicked on the + graph. + + The 'groupclick' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['toggleitem', 'togglegroup'] + + Returns + ------- + Any + """ + return self["groupclick"] + + @groupclick.setter + def groupclick(self, val): + self["groupclick"] = val + + @property + def grouptitlefont(self): + """ + Sets the font for group titles in legend. Defaults to + `legend.font` with its size increased about 10%. + + The 'grouptitlefont' property is an instance of Grouptitlefont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.legend.Grouptitlefont` + - A dict of string/value properties that will be passed + to the Grouptitlefont constructor + + Returns + ------- + plotly.graph_objs.layout.legend.Grouptitlefont + """ + return self["grouptitlefont"] + + @grouptitlefont.setter + def grouptitlefont(self, val): + self["grouptitlefont"] = val + + @property + def indentation(self): + """ + Sets the indentation (in px) of the legend entries. + + The 'indentation' property is a number and may be specified as: + - An int or float in the interval [-15, inf] + + Returns + ------- + int|float + """ + return self["indentation"] + + @indentation.setter + def indentation(self, val): + self["indentation"] = val + + @property + def itemclick(self): + """ + Determines the behavior on legend item click. "toggle" toggles + the visibility of the item clicked on the graph. "toggleothers" + makes the clicked item the sole visible item on the graph. + False disables legend item click interactions. + + The 'itemclick' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['toggle', 'toggleothers', False] + + Returns + ------- + Any + """ + return self["itemclick"] + + @itemclick.setter + def itemclick(self, val): + self["itemclick"] = val + + @property + def itemdoubleclick(self): + """ + Determines the behavior on legend item double-click. "toggle" + toggles the visibility of the item clicked on the graph. + "toggleothers" makes the clicked item the sole visible item on + the graph. False disables legend item double-click + interactions. + + The 'itemdoubleclick' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['toggle', 'toggleothers', False] + + Returns + ------- + Any + """ + return self["itemdoubleclick"] + + @itemdoubleclick.setter + def itemdoubleclick(self, val): + self["itemdoubleclick"] = val + + @property + def itemsizing(self): + """ + Determines if the legend items symbols scale with their + corresponding "trace" attributes or remain "constant" + independent of the symbol size on the graph. + + The 'itemsizing' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'constant'] + + Returns + ------- + Any + """ + return self["itemsizing"] + + @itemsizing.setter + def itemsizing(self, val): + self["itemsizing"] = val + + @property + def itemwidth(self): + """ + Sets the width (in px) of the legend item symbols (the part + other than the title.text). + + The 'itemwidth' property is a number and may be specified as: + - An int or float in the interval [30, inf] + + Returns + ------- + int|float + """ + return self["itemwidth"] + + @itemwidth.setter + def itemwidth(self, val): + self["itemwidth"] = val + + @property + def orientation(self): + """ + Sets the orientation of the legend. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.legend.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.legend.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def tracegroupgap(self): + """ + Sets the amount of vertical space (in px) between legend + groups. + + The 'tracegroupgap' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tracegroupgap"] + + @tracegroupgap.setter + def tracegroupgap(self, val): + self["tracegroupgap"] = val + + @property + def traceorder(self): + """ + Determines the order at which the legend items are displayed. + If "normal", the items are displayed top-to-bottom in the same + order as the input data. If "reversed", the items are displayed + in the opposite order as "normal". If "grouped", the items are + displayed in groups (when a trace `legendgroup` is provided). + if "grouped+reversed", the items are displayed in the opposite + order as "grouped". + + The 'traceorder' property is a flaglist and may be specified + as a string containing: + - Any combination of ['reversed', 'grouped'] joined with '+' characters + (e.g. 'reversed+grouped') + OR exactly one of ['normal'] (e.g. 'normal') + + Returns + ------- + Any + """ + return self["traceorder"] + + @traceorder.setter + def traceorder(self, val): + self["traceorder"] = val + + @property + def uirevision(self): + """ + Controls persistence of legend-driven changes in trace and pie + label visibility. Defaults to `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def valign(self): + """ + Sets the vertical alignment of the symbols with respect to + their associated text. + + The 'valign' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["valign"] + + @valign.setter + def valign(self, val): + self["valign"] = val + + @property + def visible(self): + """ + Determines whether or not this legend is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` (in normalized + coordinates) of the legend. When `xref` is "paper", defaults to + 1.02 for vertical legends and defaults to 0 for horizontal + legends. When `xref` is "container", defaults to 1 for vertical + legends and defaults to 0 for horizontal legends. Must be + between 0 and 1 if `xref` is "container". and between "-2" and + 3 if `xref` is "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the legend's horizontal position anchor. This anchor binds + the `x` position to the "left", "center" or "right" of the + legend. Value "auto" anchors legends to the right for `x` + values greater than or equal to 2/3, anchors legends to the + left for `x` values less than or equal to 1/3 and anchors + legends with respect to their center otherwise. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` (in normalized + coordinates) of the legend. When `yref` is "paper", defaults to + 1 for vertical legends, defaults to "-0.1" for horizontal + legends on graphs w/o range sliders and defaults to 1.1 for + horizontal legends on graph with one or multiple range sliders. + When `yref` is "container", defaults to 1. Must be between 0 + and 1 if `yref` is "container" and between "-2" and 3 if `yref` + is "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the legend's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + legend. Value "auto" anchors legends at their bottom for `y` + values less than or equal to 1/3, anchors legends to at their + top for `y` values greater than or equal to 2/3 and anchors + legends with respect to their middle otherwise. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the legend background color. Defaults to + `layout.paper_bgcolor`. + bordercolor + Sets the color of the border enclosing the legend. + borderwidth + Sets the width (in px) of the border enclosing the + legend. + entrywidth + Sets the width (in px or fraction) of the legend. Use 0 + to size the entry based on the text width, when + `entrywidthmode` is set to "pixels". + entrywidthmode + Determines what entrywidth means. + font + Sets the font used to text the legend items. + groupclick + Determines the behavior on legend group item click. + "toggleitem" toggles the visibility of the individual + item clicked on the graph. "togglegroup" toggles the + visibility of all items in the same legendgroup as the + item clicked on the graph. + grouptitlefont + Sets the font for group titles in legend. Defaults to + `legend.font` with its size increased about 10%. + indentation + Sets the indentation (in px) of the legend entries. + itemclick + Determines the behavior on legend item click. "toggle" + toggles the visibility of the item clicked on the + graph. "toggleothers" makes the clicked item the sole + visible item on the graph. False disables legend item + click interactions. + itemdoubleclick + Determines the behavior on legend item double-click. + "toggle" toggles the visibility of the item clicked on + the graph. "toggleothers" makes the clicked item the + sole visible item on the graph. False disables legend + item double-click interactions. + itemsizing + Determines if the legend items symbols scale with their + corresponding "trace" attributes or remain "constant" + independent of the symbol size on the graph. + itemwidth + Sets the width (in px) of the legend item symbols (the + part other than the title.text). + orientation + Sets the orientation of the legend. + title + :class:`plotly.graph_objects.layout.legend.Title` + instance or dict with compatible properties + tracegroupgap + Sets the amount of vertical space (in px) between + legend groups. + traceorder + Determines the order at which the legend items are + displayed. If "normal", the items are displayed top-to- + bottom in the same order as the input data. If + "reversed", the items are displayed in the opposite + order as "normal". If "grouped", the items are + displayed in groups (when a trace `legendgroup` is + provided). if "grouped+reversed", the items are + displayed in the opposite order as "grouped". + uirevision + Controls persistence of legend-driven changes in trace + and pie label visibility. Defaults to + `layout.uirevision`. + valign + Sets the vertical alignment of the symbols with respect + to their associated text. + visible + Determines whether or not this legend is visible. + x + Sets the x position with respect to `xref` (in + normalized coordinates) of the legend. When `xref` is + "paper", defaults to 1.02 for vertical legends and + defaults to 0 for horizontal legends. When `xref` is + "container", defaults to 1 for vertical legends and + defaults to 0 for horizontal legends. Must be between 0 + and 1 if `xref` is "container". and between "-2" and 3 + if `xref` is "paper". + xanchor + Sets the legend's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the legend. Value "auto" anchors legends + to the right for `x` values greater than or equal to + 2/3, anchors legends to the left for `x` values less + than or equal to 1/3 and anchors legends with respect + to their center otherwise. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` (in + normalized coordinates) of the legend. When `yref` is + "paper", defaults to 1 for vertical legends, defaults + to "-0.1" for horizontal legends on graphs w/o range + sliders and defaults to 1.1 for horizontal legends on + graph with one or multiple range sliders. When `yref` + is "container", defaults to 1. Must be between 0 and 1 + if `yref` is "container" and between "-2" and 3 if + `yref` is "paper". + yanchor + Sets the legend's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the legend. Value "auto" anchors legends at + their bottom for `y` values less than or equal to 1/3, + anchors legends to at their top for `y` values greater + than or equal to 2/3 and anchors legends with respect + to their middle otherwise. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + entrywidth=None, + entrywidthmode=None, + font=None, + groupclick=None, + grouptitlefont=None, + indentation=None, + itemclick=None, + itemdoubleclick=None, + itemsizing=None, + itemwidth=None, + orientation=None, + title=None, + tracegroupgap=None, + traceorder=None, + uirevision=None, + valign=None, + visible=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + **kwargs, + ): + """ + Construct a new Legend object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Legend` + bgcolor + Sets the legend background color. Defaults to + `layout.paper_bgcolor`. + bordercolor + Sets the color of the border enclosing the legend. + borderwidth + Sets the width (in px) of the border enclosing the + legend. + entrywidth + Sets the width (in px or fraction) of the legend. Use 0 + to size the entry based on the text width, when + `entrywidthmode` is set to "pixels". + entrywidthmode + Determines what entrywidth means. + font + Sets the font used to text the legend items. + groupclick + Determines the behavior on legend group item click. + "toggleitem" toggles the visibility of the individual + item clicked on the graph. "togglegroup" toggles the + visibility of all items in the same legendgroup as the + item clicked on the graph. + grouptitlefont + Sets the font for group titles in legend. Defaults to + `legend.font` with its size increased about 10%. + indentation + Sets the indentation (in px) of the legend entries. + itemclick + Determines the behavior on legend item click. "toggle" + toggles the visibility of the item clicked on the + graph. "toggleothers" makes the clicked item the sole + visible item on the graph. False disables legend item + click interactions. + itemdoubleclick + Determines the behavior on legend item double-click. + "toggle" toggles the visibility of the item clicked on + the graph. "toggleothers" makes the clicked item the + sole visible item on the graph. False disables legend + item double-click interactions. + itemsizing + Determines if the legend items symbols scale with their + corresponding "trace" attributes or remain "constant" + independent of the symbol size on the graph. + itemwidth + Sets the width (in px) of the legend item symbols (the + part other than the title.text). + orientation + Sets the orientation of the legend. + title + :class:`plotly.graph_objects.layout.legend.Title` + instance or dict with compatible properties + tracegroupgap + Sets the amount of vertical space (in px) between + legend groups. + traceorder + Determines the order at which the legend items are + displayed. If "normal", the items are displayed top-to- + bottom in the same order as the input data. If + "reversed", the items are displayed in the opposite + order as "normal". If "grouped", the items are + displayed in groups (when a trace `legendgroup` is + provided). if "grouped+reversed", the items are + displayed in the opposite order as "grouped". + uirevision + Controls persistence of legend-driven changes in trace + and pie label visibility. Defaults to + `layout.uirevision`. + valign + Sets the vertical alignment of the symbols with respect + to their associated text. + visible + Determines whether or not this legend is visible. + x + Sets the x position with respect to `xref` (in + normalized coordinates) of the legend. When `xref` is + "paper", defaults to 1.02 for vertical legends and + defaults to 0 for horizontal legends. When `xref` is + "container", defaults to 1 for vertical legends and + defaults to 0 for horizontal legends. Must be between 0 + and 1 if `xref` is "container". and between "-2" and 3 + if `xref` is "paper". + xanchor + Sets the legend's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the legend. Value "auto" anchors legends + to the right for `x` values greater than or equal to + 2/3, anchors legends to the left for `x` values less + than or equal to 1/3 and anchors legends with respect + to their center otherwise. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` (in + normalized coordinates) of the legend. When `yref` is + "paper", defaults to 1 for vertical legends, defaults + to "-0.1" for horizontal legends on graphs w/o range + sliders and defaults to 1.1 for horizontal legends on + graph with one or multiple range sliders. When `yref` + is "container", defaults to 1. Must be between 0 and 1 + if `yref` is "container" and between "-2" and 3 if + `yref` is "paper". + yanchor + Sets the legend's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the legend. Value "auto" anchors legends at + their bottom for `y` values less than or equal to 1/3, + anchors legends to at their top for `y` values greater + than or equal to 2/3 and anchors legends with respect + to their middle otherwise. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + Legend + """ + super().__init__("legend") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Legend +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Legend`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("entrywidth", arg, entrywidth) + self._set_property("entrywidthmode", arg, entrywidthmode) + self._set_property("font", arg, font) + self._set_property("groupclick", arg, groupclick) + self._set_property("grouptitlefont", arg, grouptitlefont) + self._set_property("indentation", arg, indentation) + self._set_property("itemclick", arg, itemclick) + self._set_property("itemdoubleclick", arg, itemdoubleclick) + self._set_property("itemsizing", arg, itemsizing) + self._set_property("itemwidth", arg, itemwidth) + self._set_property("orientation", arg, orientation) + self._set_property("title", arg, title) + self._set_property("tracegroupgap", arg, tracegroupgap) + self._set_property("traceorder", arg, traceorder) + self._set_property("uirevision", arg, uirevision) + self._set_property("valign", arg, valign) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_map.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_map.py new file mode 100644 index 0000000..f54257c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_map.py @@ -0,0 +1,392 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Map(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.map" + _valid_props = { + "bearing", + "bounds", + "center", + "domain", + "layerdefaults", + "layers", + "pitch", + "style", + "uirevision", + "zoom", + } + + @property + def bearing(self): + """ + Sets the bearing angle of the map in degrees counter-clockwise + from North (map.bearing). + + The 'bearing' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["bearing"] + + @bearing.setter + def bearing(self, val): + self["bearing"] = val + + @property + def bounds(self): + """ + The 'bounds' property is an instance of Bounds + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.Bounds` + - A dict of string/value properties that will be passed + to the Bounds constructor + + Returns + ------- + plotly.graph_objs.layout.map.Bounds + """ + return self["bounds"] + + @bounds.setter + def bounds(self, val): + self["bounds"] = val + + @property + def center(self): + """ + The 'center' property is an instance of Center + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.Center` + - A dict of string/value properties that will be passed + to the Center constructor + + Returns + ------- + plotly.graph_objs.layout.map.Center + """ + return self["center"] + + @center.setter + def center(self, val): + self["center"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.map.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def layers(self): + """ + The 'layers' property is a tuple of instances of + Layer that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.map.Layer + - A list or tuple of dicts of string/value properties that + will be passed to the Layer constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.map.Layer] + """ + return self["layers"] + + @layers.setter + def layers(self, val): + self["layers"] = val + + @property + def layerdefaults(self): + """ + When used in a template (as + layout.template.layout.map.layerdefaults), sets the default + property values to use for elements of layout.map.layers + + The 'layerdefaults' property is an instance of Layer + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.Layer` + - A dict of string/value properties that will be passed + to the Layer constructor + + Returns + ------- + plotly.graph_objs.layout.map.Layer + """ + return self["layerdefaults"] + + @layerdefaults.setter + def layerdefaults(self, val): + self["layerdefaults"] = val + + @property + def pitch(self): + """ + Sets the pitch angle of the map (in degrees, where 0 means + perpendicular to the surface of the map) (map.pitch). + + The 'pitch' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["pitch"] + + @pitch.setter + def pitch(self, val): + self["pitch"] = val + + @property + def style(self): + """ + Defines the map layers that are rendered by default below the + trace layers defined in `data`, which are themselves by default + rendered below the layers defined in `layout.map.layers`. + These layers can be defined either explicitly as a Map Style + object which can contain multiple layer definitions that load + data from any public or private Tile Map Service (TMS or XYZ) + or Web Map Service (WMS) or implicitly by using one of the + built-in style objects which use WMSes or by using a custom + style URL Map Style objects are of the form described in the + MapLibre GL JS documentation available at + https://maplibre.org/maplibre-style-spec/ The built-in + plotly.js styles objects are: basic, carto-darkmatter, carto- + darkmatter-nolabels, carto-positron, carto-positron-nolabels, + carto-voyager, carto-voyager-nolabels, dark, light, open- + street-map, outdoors, satellite, satellite-streets, streets, + white-bg. + + The 'style' property accepts values of any type + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in the view: + `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def zoom(self): + """ + Sets the zoom level of the map (map.zoom). + + The 'zoom' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zoom"] + + @zoom.setter + def zoom(self, val): + self["zoom"] = val + + @property + def _prop_descriptions(self): + return """\ + bearing + Sets the bearing angle of the map in degrees counter- + clockwise from North (map.bearing). + bounds + :class:`plotly.graph_objects.layout.map.Bounds` + instance or dict with compatible properties + center + :class:`plotly.graph_objects.layout.map.Center` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.map.Domain` + instance or dict with compatible properties + layers + A tuple of + :class:`plotly.graph_objects.layout.map.Layer` + instances or dicts with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.map.layerdefaults), sets the + default property values to use for elements of + layout.map.layers + pitch + Sets the pitch angle of the map (in degrees, where 0 + means perpendicular to the surface of the map) + (map.pitch). + style + Defines the map layers that are rendered by default + below the trace layers defined in `data`, which are + themselves by default rendered below the layers defined + in `layout.map.layers`. These layers can be defined + either explicitly as a Map Style object which can + contain multiple layer definitions that load data from + any public or private Tile Map Service (TMS or XYZ) or + Web Map Service (WMS) or implicitly by using one of the + built-in style objects which use WMSes or by using a + custom style URL Map Style objects are of the form + described in the MapLibre GL JS documentation available + at https://maplibre.org/maplibre-style-spec/ The + built-in plotly.js styles objects are: basic, carto- + darkmatter, carto-darkmatter-nolabels, carto-positron, + carto-positron-nolabels, carto-voyager, carto-voyager- + nolabels, dark, light, open-street-map, outdoors, + satellite, satellite-streets, streets, white-bg. + uirevision + Controls persistence of user-driven changes in the + view: `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + zoom + Sets the zoom level of the map (map.zoom). + """ + + def __init__( + self, + arg=None, + bearing=None, + bounds=None, + center=None, + domain=None, + layers=None, + layerdefaults=None, + pitch=None, + style=None, + uirevision=None, + zoom=None, + **kwargs, + ): + """ + Construct a new Map object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Map` + bearing + Sets the bearing angle of the map in degrees counter- + clockwise from North (map.bearing). + bounds + :class:`plotly.graph_objects.layout.map.Bounds` + instance or dict with compatible properties + center + :class:`plotly.graph_objects.layout.map.Center` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.map.Domain` + instance or dict with compatible properties + layers + A tuple of + :class:`plotly.graph_objects.layout.map.Layer` + instances or dicts with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.map.layerdefaults), sets the + default property values to use for elements of + layout.map.layers + pitch + Sets the pitch angle of the map (in degrees, where 0 + means perpendicular to the surface of the map) + (map.pitch). + style + Defines the map layers that are rendered by default + below the trace layers defined in `data`, which are + themselves by default rendered below the layers defined + in `layout.map.layers`. These layers can be defined + either explicitly as a Map Style object which can + contain multiple layer definitions that load data from + any public or private Tile Map Service (TMS or XYZ) or + Web Map Service (WMS) or implicitly by using one of the + built-in style objects which use WMSes or by using a + custom style URL Map Style objects are of the form + described in the MapLibre GL JS documentation available + at https://maplibre.org/maplibre-style-spec/ The + built-in plotly.js styles objects are: basic, carto- + darkmatter, carto-darkmatter-nolabels, carto-positron, + carto-positron-nolabels, carto-voyager, carto-voyager- + nolabels, dark, light, open-street-map, outdoors, + satellite, satellite-streets, streets, white-bg. + uirevision + Controls persistence of user-driven changes in the + view: `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + zoom + Sets the zoom level of the map (map.zoom). + + Returns + ------- + Map + """ + super().__init__("map") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Map +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Map`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bearing", arg, bearing) + self._set_property("bounds", arg, bounds) + self._set_property("center", arg, center) + self._set_property("domain", arg, domain) + self._set_property("layers", arg, layers) + self._set_property("layerdefaults", arg, layerdefaults) + self._set_property("pitch", arg, pitch) + self._set_property("style", arg, style) + self._set_property("uirevision", arg, uirevision) + self._set_property("zoom", arg, zoom) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_mapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_mapbox.py new file mode 100644 index 0000000..b0f5e4e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_mapbox.py @@ -0,0 +1,452 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Mapbox(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.mapbox" + _valid_props = { + "accesstoken", + "bearing", + "bounds", + "center", + "domain", + "layerdefaults", + "layers", + "pitch", + "style", + "uirevision", + "zoom", + } + + @property + def accesstoken(self): + """ + Sets the mapbox access token to be used for this mapbox map. + Alternatively, the mapbox access token can be set in the + configuration options under `mapboxAccessToken`. Note that + accessToken are only required when `style` (e.g with values : + basic, streets, outdoors, light, dark, satellite, satellite- + streets ) and/or a layout layer references the Mapbox server. + + The 'accesstoken' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["accesstoken"] + + @accesstoken.setter + def accesstoken(self, val): + self["accesstoken"] = val + + @property + def bearing(self): + """ + Sets the bearing angle of the map in degrees counter-clockwise + from North (mapbox.bearing). + + The 'bearing' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["bearing"] + + @bearing.setter + def bearing(self, val): + self["bearing"] = val + + @property + def bounds(self): + """ + The 'bounds' property is an instance of Bounds + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.Bounds` + - A dict of string/value properties that will be passed + to the Bounds constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.Bounds + """ + return self["bounds"] + + @bounds.setter + def bounds(self, val): + self["bounds"] = val + + @property + def center(self): + """ + The 'center' property is an instance of Center + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.Center` + - A dict of string/value properties that will be passed + to the Center constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.Center + """ + return self["center"] + + @center.setter + def center(self, val): + self["center"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def layers(self): + """ + The 'layers' property is a tuple of instances of + Layer that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.mapbox.Layer + - A list or tuple of dicts of string/value properties that + will be passed to the Layer constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.mapbox.Layer] + """ + return self["layers"] + + @layers.setter + def layers(self, val): + self["layers"] = val + + @property + def layerdefaults(self): + """ + When used in a template (as + layout.template.layout.mapbox.layerdefaults), sets the default + property values to use for elements of layout.mapbox.layers + + The 'layerdefaults' property is an instance of Layer + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.Layer` + - A dict of string/value properties that will be passed + to the Layer constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.Layer + """ + return self["layerdefaults"] + + @layerdefaults.setter + def layerdefaults(self, val): + self["layerdefaults"] = val + + @property + def pitch(self): + """ + Sets the pitch angle of the map (in degrees, where 0 means + perpendicular to the surface of the map) (mapbox.pitch). + + The 'pitch' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["pitch"] + + @pitch.setter + def pitch(self, val): + self["pitch"] = val + + @property + def style(self): + """ + Defines the map layers that are rendered by default below the + trace layers defined in `data`, which are themselves by default + rendered below the layers defined in `layout.mapbox.layers`. + These layers can be defined either explicitly as a Mapbox Style + object which can contain multiple layer definitions that load + data from any public or private Tile Map Service (TMS or XYZ) + or Web Map Service (WMS) or implicitly by using one of the + built-in style objects which use WMSes which do not require any + access tokens, or by using a default Mapbox style or custom + Mapbox style URL, both of which require a Mapbox access token + Note that Mapbox access token can be set in the `accesstoken` + attribute or in the `mapboxAccessToken` config option. Mapbox + Style objects are of the form described in the Mapbox GL JS + documentation available at https://docs.mapbox.com/mapbox-gl- + js/style-spec The built-in plotly.js styles objects are: + carto-darkmatter, carto-positron, open-street-map, stamen- + terrain, stamen-toner, stamen-watercolor, white-bg The built- + in Mapbox styles are: basic, streets, outdoors, light, dark, + satellite, satellite-streets Mapbox style URLs are of the + form: mapbox://mapbox.mapbox-- + + The 'style' property accepts values of any type + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in the view: + `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def zoom(self): + """ + Sets the zoom level of the map (mapbox.zoom). + + The 'zoom' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zoom"] + + @zoom.setter + def zoom(self, val): + self["zoom"] = val + + @property + def _prop_descriptions(self): + return """\ + accesstoken + Sets the mapbox access token to be used for this mapbox + map. Alternatively, the mapbox access token can be set + in the configuration options under `mapboxAccessToken`. + Note that accessToken are only required when `style` + (e.g with values : basic, streets, outdoors, light, + dark, satellite, satellite-streets ) and/or a layout + layer references the Mapbox server. + bearing + Sets the bearing angle of the map in degrees counter- + clockwise from North (mapbox.bearing). + bounds + :class:`plotly.graph_objects.layout.mapbox.Bounds` + instance or dict with compatible properties + center + :class:`plotly.graph_objects.layout.mapbox.Center` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.mapbox.Domain` + instance or dict with compatible properties + layers + A tuple of + :class:`plotly.graph_objects.layout.mapbox.Layer` + instances or dicts with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.mapbox.layerdefaults), sets the + default property values to use for elements of + layout.mapbox.layers + pitch + Sets the pitch angle of the map (in degrees, where 0 + means perpendicular to the surface of the map) + (mapbox.pitch). + style + Defines the map layers that are rendered by default + below the trace layers defined in `data`, which are + themselves by default rendered below the layers defined + in `layout.mapbox.layers`. These layers can be defined + either explicitly as a Mapbox Style object which can + contain multiple layer definitions that load data from + any public or private Tile Map Service (TMS or XYZ) or + Web Map Service (WMS) or implicitly by using one of the + built-in style objects which use WMSes which do not + require any access tokens, or by using a default Mapbox + style or custom Mapbox style URL, both of which require + a Mapbox access token Note that Mapbox access token + can be set in the `accesstoken` attribute or in the + `mapboxAccessToken` config option. Mapbox Style + objects are of the form described in the Mapbox GL JS + documentation available at + https://docs.mapbox.com/mapbox-gl-js/style-spec The + built-in plotly.js styles objects are: carto- + darkmatter, carto-positron, open-street-map, stamen- + terrain, stamen-toner, stamen-watercolor, white-bg The + built-in Mapbox styles are: basic, streets, outdoors, + light, dark, satellite, satellite-streets Mapbox style + URLs are of the form: + mapbox://mapbox.mapbox-- + uirevision + Controls persistence of user-driven changes in the + view: `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + zoom + Sets the zoom level of the map (mapbox.zoom). + """ + + def __init__( + self, + arg=None, + accesstoken=None, + bearing=None, + bounds=None, + center=None, + domain=None, + layers=None, + layerdefaults=None, + pitch=None, + style=None, + uirevision=None, + zoom=None, + **kwargs, + ): + """ + Construct a new Mapbox object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Mapbox` + accesstoken + Sets the mapbox access token to be used for this mapbox + map. Alternatively, the mapbox access token can be set + in the configuration options under `mapboxAccessToken`. + Note that accessToken are only required when `style` + (e.g with values : basic, streets, outdoors, light, + dark, satellite, satellite-streets ) and/or a layout + layer references the Mapbox server. + bearing + Sets the bearing angle of the map in degrees counter- + clockwise from North (mapbox.bearing). + bounds + :class:`plotly.graph_objects.layout.mapbox.Bounds` + instance or dict with compatible properties + center + :class:`plotly.graph_objects.layout.mapbox.Center` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.mapbox.Domain` + instance or dict with compatible properties + layers + A tuple of + :class:`plotly.graph_objects.layout.mapbox.Layer` + instances or dicts with compatible properties + layerdefaults + When used in a template (as + layout.template.layout.mapbox.layerdefaults), sets the + default property values to use for elements of + layout.mapbox.layers + pitch + Sets the pitch angle of the map (in degrees, where 0 + means perpendicular to the surface of the map) + (mapbox.pitch). + style + Defines the map layers that are rendered by default + below the trace layers defined in `data`, which are + themselves by default rendered below the layers defined + in `layout.mapbox.layers`. These layers can be defined + either explicitly as a Mapbox Style object which can + contain multiple layer definitions that load data from + any public or private Tile Map Service (TMS or XYZ) or + Web Map Service (WMS) or implicitly by using one of the + built-in style objects which use WMSes which do not + require any access tokens, or by using a default Mapbox + style or custom Mapbox style URL, both of which require + a Mapbox access token Note that Mapbox access token + can be set in the `accesstoken` attribute or in the + `mapboxAccessToken` config option. Mapbox Style + objects are of the form described in the Mapbox GL JS + documentation available at + https://docs.mapbox.com/mapbox-gl-js/style-spec The + built-in plotly.js styles objects are: carto- + darkmatter, carto-positron, open-street-map, stamen- + terrain, stamen-toner, stamen-watercolor, white-bg The + built-in Mapbox styles are: basic, streets, outdoors, + light, dark, satellite, satellite-streets Mapbox style + URLs are of the form: + mapbox://mapbox.mapbox-- + uirevision + Controls persistence of user-driven changes in the + view: `center`, `zoom`, `bearing`, `pitch`. Defaults to + `layout.uirevision`. + zoom + Sets the zoom level of the map (mapbox.zoom). + + Returns + ------- + Mapbox + """ + super().__init__("mapbox") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Mapbox +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Mapbox`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("accesstoken", arg, accesstoken) + self._set_property("bearing", arg, bearing) + self._set_property("bounds", arg, bounds) + self._set_property("center", arg, center) + self._set_property("domain", arg, domain) + self._set_property("layers", arg, layers) + self._set_property("layerdefaults", arg, layerdefaults) + self._set_property("pitch", arg, pitch) + self._set_property("style", arg, style) + self._set_property("uirevision", arg, uirevision) + self._set_property("zoom", arg, zoom) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_margin.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_margin.py new file mode 100644 index 0000000..2af6048 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_margin.py @@ -0,0 +1,212 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Margin(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.margin" + _valid_props = {"autoexpand", "b", "l", "pad", "r", "t"} + + @property + def autoexpand(self): + """ + Turns on/off margin expansion computations. Legends, colorbars, + updatemenus, sliders, axis rangeselector and rangeslider are + allowed to push the margins by defaults. + + The 'autoexpand' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autoexpand"] + + @autoexpand.setter + def autoexpand(self, val): + self["autoexpand"] = val + + @property + def b(self): + """ + Sets the bottom margin (in px). + + The 'b' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def l(self): + """ + Sets the left margin (in px). + + The 'l' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["l"] + + @l.setter + def l(self, val): + self["l"] = val + + @property + def pad(self): + """ + Sets the amount of padding (in px) between the plotting area + and the axis lines + + The 'pad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def r(self): + """ + Sets the right margin (in px). + + The 'r' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def t(self): + """ + Sets the top margin (in px). + + The 't' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["t"] + + @t.setter + def t(self, val): + self["t"] = val + + @property + def _prop_descriptions(self): + return """\ + autoexpand + Turns on/off margin expansion computations. Legends, + colorbars, updatemenus, sliders, axis rangeselector and + rangeslider are allowed to push the margins by + defaults. + b + Sets the bottom margin (in px). + l + Sets the left margin (in px). + pad + Sets the amount of padding (in px) between the plotting + area and the axis lines + r + Sets the right margin (in px). + t + Sets the top margin (in px). + """ + + def __init__( + self, + arg=None, + autoexpand=None, + b=None, + l=None, + pad=None, + r=None, + t=None, + **kwargs, + ): + """ + Construct a new Margin object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Margin` + autoexpand + Turns on/off margin expansion computations. Legends, + colorbars, updatemenus, sliders, axis rangeselector and + rangeslider are allowed to push the margins by + defaults. + b + Sets the bottom margin (in px). + l + Sets the left margin (in px). + pad + Sets the amount of padding (in px) between the plotting + area and the axis lines + r + Sets the right margin (in px). + t + Sets the top margin (in px). + + Returns + ------- + Margin + """ + super().__init__("margin") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Margin +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Margin`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autoexpand", arg, autoexpand) + self._set_property("b", arg, b) + self._set_property("l", arg, l) + self._set_property("pad", arg, pad) + self._set_property("r", arg, r) + self._set_property("t", arg, t) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_modebar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_modebar.py new file mode 100644 index 0000000..34b9180 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_modebar.py @@ -0,0 +1,387 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Modebar(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.modebar" + _valid_props = { + "activecolor", + "add", + "addsrc", + "bgcolor", + "color", + "orientation", + "remove", + "removesrc", + "uirevision", + } + + @property + def activecolor(self): + """ + Sets the color of the active or hovered on icons in the + modebar. + + The 'activecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["activecolor"] + + @activecolor.setter + def activecolor(self, val): + self["activecolor"] = val + + @property + def add(self): + """ + Determines which predefined modebar buttons to add. Please note + that these buttons will only be shown if they are compatible + with all trace types used in a graph. Similar to + `config.modeBarButtonsToAdd` option. This may include + "v1hovermode", "hoverclosest", "hovercompare", "togglehover", + "togglespikelines", "drawline", "drawopenpath", + "drawclosedpath", "drawcircle", "drawrect", "eraseshape". + + The 'add' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["add"] + + @add.setter + def add(self, val): + self["add"] = val + + @property + def addsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `add`. + + The 'addsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["addsrc"] + + @addsrc.setter + def addsrc(self, val): + self["addsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the modebar. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def color(self): + """ + Sets the color of the icons in the modebar. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def orientation(self): + """ + Sets the orientation of the modebar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['v', 'h'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def remove(self): + """ + Determines which predefined modebar buttons to remove. Similar + to `config.modeBarButtonsToRemove` option. This may include + "autoScale2d", "autoscale", "editInChartStudio", + "editinchartstudio", "hoverCompareCartesian", "hovercompare", + "lasso", "lasso2d", "orbitRotation", "orbitrotation", "pan", + "pan2d", "pan3d", "reset", "resetCameraDefault3d", + "resetCameraLastSave3d", "resetGeo", "resetSankeyGroup", + "resetScale2d", "resetViewMap", "resetViewMapbox", + "resetViews", "resetcameradefault", "resetcameralastsave", + "resetsankeygroup", "resetscale", "resetview", "resetviews", + "select", "select2d", "sendDataToCloud", "senddatatocloud", + "tableRotation", "tablerotation", "toImage", "toggleHover", + "toggleSpikelines", "togglehover", "togglespikelines", + "toimage", "zoom", "zoom2d", "zoom3d", "zoomIn2d", "zoomInGeo", + "zoomInMap", "zoomInMapbox", "zoomOut2d", "zoomOutGeo", + "zoomOutMap", "zoomOutMapbox", "zoomin", "zoomout". + + The 'remove' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["remove"] + + @remove.setter + def remove(self, val): + self["remove"] = val + + @property + def removesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `remove`. + + The 'removesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["removesrc"] + + @removesrc.setter + def removesrc(self, val): + self["removesrc"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes related to the + modebar, including `hovermode`, `dragmode`, and `showspikes` at + both the root level and inside subplots. Defaults to + `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def _prop_descriptions(self): + return """\ + activecolor + Sets the color of the active or hovered on icons in the + modebar. + add + Determines which predefined modebar buttons to add. + Please note that these buttons will only be shown if + they are compatible with all trace types used in a + graph. Similar to `config.modeBarButtonsToAdd` option. + This may include "v1hovermode", "hoverclosest", + "hovercompare", "togglehover", "togglespikelines", + "drawline", "drawopenpath", "drawclosedpath", + "drawcircle", "drawrect", "eraseshape". + addsrc + Sets the source reference on Chart Studio Cloud for + `add`. + bgcolor + Sets the background color of the modebar. + color + Sets the color of the icons in the modebar. + orientation + Sets the orientation of the modebar. + remove + Determines which predefined modebar buttons to remove. + Similar to `config.modeBarButtonsToRemove` option. This + may include "autoScale2d", "autoscale", + "editInChartStudio", "editinchartstudio", + "hoverCompareCartesian", "hovercompare", "lasso", + "lasso2d", "orbitRotation", "orbitrotation", "pan", + "pan2d", "pan3d", "reset", "resetCameraDefault3d", + "resetCameraLastSave3d", "resetGeo", + "resetSankeyGroup", "resetScale2d", "resetViewMap", + "resetViewMapbox", "resetViews", "resetcameradefault", + "resetcameralastsave", "resetsankeygroup", + "resetscale", "resetview", "resetviews", "select", + "select2d", "sendDataToCloud", "senddatatocloud", + "tableRotation", "tablerotation", "toImage", + "toggleHover", "toggleSpikelines", "togglehover", + "togglespikelines", "toimage", "zoom", "zoom2d", + "zoom3d", "zoomIn2d", "zoomInGeo", "zoomInMap", + "zoomInMapbox", "zoomOut2d", "zoomOutGeo", + "zoomOutMap", "zoomOutMapbox", "zoomin", "zoomout". + removesrc + Sets the source reference on Chart Studio Cloud for + `remove`. + uirevision + Controls persistence of user-driven changes related to + the modebar, including `hovermode`, `dragmode`, and + `showspikes` at both the root level and inside + subplots. Defaults to `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + activecolor=None, + add=None, + addsrc=None, + bgcolor=None, + color=None, + orientation=None, + remove=None, + removesrc=None, + uirevision=None, + **kwargs, + ): + """ + Construct a new Modebar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Modebar` + activecolor + Sets the color of the active or hovered on icons in the + modebar. + add + Determines which predefined modebar buttons to add. + Please note that these buttons will only be shown if + they are compatible with all trace types used in a + graph. Similar to `config.modeBarButtonsToAdd` option. + This may include "v1hovermode", "hoverclosest", + "hovercompare", "togglehover", "togglespikelines", + "drawline", "drawopenpath", "drawclosedpath", + "drawcircle", "drawrect", "eraseshape". + addsrc + Sets the source reference on Chart Studio Cloud for + `add`. + bgcolor + Sets the background color of the modebar. + color + Sets the color of the icons in the modebar. + orientation + Sets the orientation of the modebar. + remove + Determines which predefined modebar buttons to remove. + Similar to `config.modeBarButtonsToRemove` option. This + may include "autoScale2d", "autoscale", + "editInChartStudio", "editinchartstudio", + "hoverCompareCartesian", "hovercompare", "lasso", + "lasso2d", "orbitRotation", "orbitrotation", "pan", + "pan2d", "pan3d", "reset", "resetCameraDefault3d", + "resetCameraLastSave3d", "resetGeo", + "resetSankeyGroup", "resetScale2d", "resetViewMap", + "resetViewMapbox", "resetViews", "resetcameradefault", + "resetcameralastsave", "resetsankeygroup", + "resetscale", "resetview", "resetviews", "select", + "select2d", "sendDataToCloud", "senddatatocloud", + "tableRotation", "tablerotation", "toImage", + "toggleHover", "toggleSpikelines", "togglehover", + "togglespikelines", "toimage", "zoom", "zoom2d", + "zoom3d", "zoomIn2d", "zoomInGeo", "zoomInMap", + "zoomInMapbox", "zoomOut2d", "zoomOutGeo", + "zoomOutMap", "zoomOutMapbox", "zoomin", "zoomout". + removesrc + Sets the source reference on Chart Studio Cloud for + `remove`. + uirevision + Controls persistence of user-driven changes related to + the modebar, including `hovermode`, `dragmode`, and + `showspikes` at both the root level and inside + subplots. Defaults to `layout.uirevision`. + + Returns + ------- + Modebar + """ + super().__init__("modebar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Modebar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Modebar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("activecolor", arg, activecolor) + self._set_property("add", arg, add) + self._set_property("addsrc", arg, addsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("color", arg, color) + self._set_property("orientation", arg, orientation) + self._set_property("remove", arg, remove) + self._set_property("removesrc", arg, removesrc) + self._set_property("uirevision", arg, uirevision) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newselection.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newselection.py new file mode 100644 index 0000000..4f06571 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newselection.py @@ -0,0 +1,118 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Newselection(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.newselection" + _valid_props = {"line", "mode"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.newselection.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.layout.newselection.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def mode(self): + """ + Describes how a new selection is created. If `immediate`, a new + selection is created after first mouse up. If `gradual`, a new + selection is not created after first mouse. By adding to and + subtracting from the initial selection, this option allows + declaring extra outlines of the selection. + + The 'mode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['immediate', 'gradual'] + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.layout.newselection.Line` + instance or dict with compatible properties + mode + Describes how a new selection is created. If + `immediate`, a new selection is created after first + mouse up. If `gradual`, a new selection is not created + after first mouse. By adding to and subtracting from + the initial selection, this option allows declaring + extra outlines of the selection. + """ + + def __init__(self, arg=None, line=None, mode=None, **kwargs): + """ + Construct a new Newselection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Newselection` + line + :class:`plotly.graph_objects.layout.newselection.Line` + instance or dict with compatible properties + mode + Describes how a new selection is created. If + `immediate`, a new selection is created after first + mouse up. If `gradual`, a new selection is not created + after first mouse. By adding to and subtracting from + the initial selection, this option allows declaring + extra outlines of the selection. + + Returns + ------- + Newselection + """ + super().__init__("newselection") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Newselection +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Newselection`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("mode", arg, mode) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newshape.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newshape.py new file mode 100644 index 0000000..05710a1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_newshape.py @@ -0,0 +1,543 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Newshape(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.newshape" + _valid_props = { + "drawdirection", + "fillcolor", + "fillrule", + "label", + "layer", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "name", + "opacity", + "showlegend", + "visible", + } + + @property + def drawdirection(self): + """ + When `dragmode` is set to "drawrect", "drawline" or + "drawcircle" this limits the drag to be horizontal, vertical or + diagonal. Using "diagonal" there is no limit e.g. in drawing + lines in any direction. "ortho" limits the draw to be either + horizontal or vertical. "horizontal" allows horizontal extend. + "vertical" allows vertical extend. + + The 'drawdirection' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['ortho', 'horizontal', 'vertical', 'diagonal'] + + Returns + ------- + Any + """ + return self["drawdirection"] + + @drawdirection.setter + def drawdirection(self, val): + self["drawdirection"] = val + + @property + def fillcolor(self): + """ + Sets the color filling new shapes' interior. Please note that + if using a fillcolor with alpha greater than half, drag inside + the active shape starts moving the shape underneath, otherwise + a new shape could be started over. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def fillrule(self): + """ + Determines the path's interior. For more info please visit + https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + + The 'fillrule' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['evenodd', 'nonzero'] + + Returns + ------- + Any + """ + return self["fillrule"] + + @fillrule.setter + def fillrule(self, val): + self["fillrule"] = val + + @property + def label(self): + """ + The 'label' property is an instance of Label + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.newshape.Label` + - A dict of string/value properties that will be passed + to the Label constructor + + Returns + ------- + plotly.graph_objs.layout.newshape.Label + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def layer(self): + """ + Specifies whether new shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or above + traces ("above"). + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['below', 'above', 'between'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show new shape in. References + to these legends are "legend", "legend2", "legend3", etc. + Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for new shape. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.newshape.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.layout.newshape.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for new shape. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for new shape. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.newshape.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.layout.newshape.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def name(self): + """ + Sets new shape name. The name appears as the legend item. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of new shapes. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def showlegend(self): + """ + Determines whether or not new shape is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def visible(self): + """ + Determines whether or not new shape is visible. If + "legendonly", the shape is not drawn, but can appear as a + legend item (provided that the legend itself is visible). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + drawdirection + When `dragmode` is set to "drawrect", "drawline" or + "drawcircle" this limits the drag to be horizontal, + vertical or diagonal. Using "diagonal" there is no + limit e.g. in drawing lines in any direction. "ortho" + limits the draw to be either horizontal or vertical. + "horizontal" allows horizontal extend. "vertical" + allows vertical extend. + fillcolor + Sets the color filling new shapes' interior. Please + note that if using a fillcolor with alpha greater than + half, drag inside the active shape starts moving the + shape underneath, otherwise a new shape could be + started over. + fillrule + Determines the path's interior. For more info please + visit https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + label + :class:`plotly.graph_objects.layout.newshape.Label` + instance or dict with compatible properties + layer + Specifies whether new shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or + above traces ("above"). + legend + Sets the reference to a legend to show new shape in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for new shape. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.layout.newshape.Legendgrou + ptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for new shape. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. + legendwidth + Sets the width (in px or fraction) of the legend for + new shape. + line + :class:`plotly.graph_objects.layout.newshape.Line` + instance or dict with compatible properties + name + Sets new shape name. The name appears as the legend + item. + opacity + Sets the opacity of new shapes. + showlegend + Determines whether or not new shape is shown in the + legend. + visible + Determines whether or not new shape is visible. If + "legendonly", the shape is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + """ + + def __init__( + self, + arg=None, + drawdirection=None, + fillcolor=None, + fillrule=None, + label=None, + layer=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + name=None, + opacity=None, + showlegend=None, + visible=None, + **kwargs, + ): + """ + Construct a new Newshape object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Newshape` + drawdirection + When `dragmode` is set to "drawrect", "drawline" or + "drawcircle" this limits the drag to be horizontal, + vertical or diagonal. Using "diagonal" there is no + limit e.g. in drawing lines in any direction. "ortho" + limits the draw to be either horizontal or vertical. + "horizontal" allows horizontal extend. "vertical" + allows vertical extend. + fillcolor + Sets the color filling new shapes' interior. Please + note that if using a fillcolor with alpha greater than + half, drag inside the active shape starts moving the + shape underneath, otherwise a new shape could be + started over. + fillrule + Determines the path's interior. For more info please + visit https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + label + :class:`plotly.graph_objects.layout.newshape.Label` + instance or dict with compatible properties + layer + Specifies whether new shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or + above traces ("above"). + legend + Sets the reference to a legend to show new shape in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for new shape. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.layout.newshape.Legendgrou + ptitle` instance or dict with compatible properties + legendrank + Sets the legend rank for new shape. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. + legendwidth + Sets the width (in px or fraction) of the legend for + new shape. + line + :class:`plotly.graph_objects.layout.newshape.Line` + instance or dict with compatible properties + name + Sets new shape name. The name appears as the legend + item. + opacity + Sets the opacity of new shapes. + showlegend + Determines whether or not new shape is shown in the + legend. + visible + Determines whether or not new shape is visible. If + "legendonly", the shape is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + + Returns + ------- + Newshape + """ + super().__init__("newshape") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Newshape +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Newshape`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("drawdirection", arg, drawdirection) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("fillrule", arg, fillrule) + self._set_property("label", arg, label) + self._set_property("layer", arg, layer) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("showlegend", arg, showlegend) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_polar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_polar.py new file mode 100644 index 0000000..51d7620 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_polar.py @@ -0,0 +1,382 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Polar(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.polar" + _valid_props = { + "angularaxis", + "bargap", + "barmode", + "bgcolor", + "domain", + "gridshape", + "hole", + "radialaxis", + "sector", + "uirevision", + } + + @property + def angularaxis(self): + """ + The 'angularaxis' property is an instance of AngularAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.AngularAxis` + - A dict of string/value properties that will be passed + to the AngularAxis constructor + + Returns + ------- + plotly.graph_objs.layout.polar.AngularAxis + """ + return self["angularaxis"] + + @angularaxis.setter + def angularaxis(self, val): + self["angularaxis"] = val + + @property + def bargap(self): + """ + Sets the gap between bars of adjacent location coordinates. + Values are unitless, they represent fractions of the minimum + difference in bar positions in the data. + + The 'bargap' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["bargap"] + + @bargap.setter + def bargap(self, val): + self["bargap"] = val + + @property + def barmode(self): + """ + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are stacked on + top of one another With "overlay", the bars are plotted over + one another, you might need to reduce "opacity" to see multiple + bars. + + The 'barmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['stack', 'overlay'] + + Returns + ------- + Any + """ + return self["barmode"] + + @barmode.setter + def barmode(self, val): + self["barmode"] = val + + @property + def bgcolor(self): + """ + Set the background color of the subplot + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.polar.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def gridshape(self): + """ + Determines if the radial axis grid lines and angular axis line + are drawn as "circular" sectors or as "linear" (polygon) + sectors. Has an effect only when the angular axis has `type` + "category". Note that `radialaxis.angle` is snapped to the + angle of the closest vertex when `gridshape` is "circular" (so + that radial axis scale is the same as the data scale). + + The 'gridshape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circular', 'linear'] + + Returns + ------- + Any + """ + return self["gridshape"] + + @gridshape.setter + def gridshape(self, val): + self["gridshape"] = val + + @property + def hole(self): + """ + Sets the fraction of the radius to cut out of the polar + subplot. + + The 'hole' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["hole"] + + @hole.setter + def hole(self, val): + self["hole"] = val + + @property + def radialaxis(self): + """ + The 'radialaxis' property is an instance of RadialAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.RadialAxis` + - A dict of string/value properties that will be passed + to the RadialAxis constructor + + Returns + ------- + plotly.graph_objs.layout.polar.RadialAxis + """ + return self["radialaxis"] + + @radialaxis.setter + def radialaxis(self, val): + self["radialaxis"] = val + + @property + def sector(self): + """ + Sets angular span of this polar subplot with two angles (in + degrees). Sector are assumed to be spanned in the + counterclockwise direction with 0 corresponding to rightmost + limit of the polar subplot. + + The 'sector' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'sector[0]' property is a number and may be specified as: + - An int or float + (1) The 'sector[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["sector"] + + @sector.setter + def sector(self, val): + self["sector"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis attributes, + if not overridden in the individual axes. Defaults to + `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def _prop_descriptions(self): + return """\ + angularaxis + :class:`plotly.graph_objects.layout.polar.AngularAxis` + instance or dict with compatible properties + bargap + Sets the gap between bars of adjacent location + coordinates. Values are unitless, they represent + fractions of the minimum difference in bar positions in + the data. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "overlay", the bars + are plotted over one another, you might need to reduce + "opacity" to see multiple bars. + bgcolor + Set the background color of the subplot + domain + :class:`plotly.graph_objects.layout.polar.Domain` + instance or dict with compatible properties + gridshape + Determines if the radial axis grid lines and angular + axis line are drawn as "circular" sectors or as + "linear" (polygon) sectors. Has an effect only when the + angular axis has `type` "category". Note that + `radialaxis.angle` is snapped to the angle of the + closest vertex when `gridshape` is "circular" (so that + radial axis scale is the same as the data scale). + hole + Sets the fraction of the radius to cut out of the polar + subplot. + radialaxis + :class:`plotly.graph_objects.layout.polar.RadialAxis` + instance or dict with compatible properties + sector + Sets angular span of this polar subplot with two angles + (in degrees). Sector are assumed to be spanned in the + counterclockwise direction with 0 corresponding to + rightmost limit of the polar subplot. + uirevision + Controls persistence of user-driven changes in axis + attributes, if not overridden in the individual axes. + Defaults to `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + angularaxis=None, + bargap=None, + barmode=None, + bgcolor=None, + domain=None, + gridshape=None, + hole=None, + radialaxis=None, + sector=None, + uirevision=None, + **kwargs, + ): + """ + Construct a new Polar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Polar` + angularaxis + :class:`plotly.graph_objects.layout.polar.AngularAxis` + instance or dict with compatible properties + bargap + Sets the gap between bars of adjacent location + coordinates. Values are unitless, they represent + fractions of the minimum difference in bar positions in + the data. + barmode + Determines how bars at the same location coordinate are + displayed on the graph. With "stack", the bars are + stacked on top of one another With "overlay", the bars + are plotted over one another, you might need to reduce + "opacity" to see multiple bars. + bgcolor + Set the background color of the subplot + domain + :class:`plotly.graph_objects.layout.polar.Domain` + instance or dict with compatible properties + gridshape + Determines if the radial axis grid lines and angular + axis line are drawn as "circular" sectors or as + "linear" (polygon) sectors. Has an effect only when the + angular axis has `type` "category". Note that + `radialaxis.angle` is snapped to the angle of the + closest vertex when `gridshape` is "circular" (so that + radial axis scale is the same as the data scale). + hole + Sets the fraction of the radius to cut out of the polar + subplot. + radialaxis + :class:`plotly.graph_objects.layout.polar.RadialAxis` + instance or dict with compatible properties + sector + Sets angular span of this polar subplot with two angles + (in degrees). Sector are assumed to be spanned in the + counterclockwise direction with 0 corresponding to + rightmost limit of the polar subplot. + uirevision + Controls persistence of user-driven changes in axis + attributes, if not overridden in the individual axes. + Defaults to `layout.uirevision`. + + Returns + ------- + Polar + """ + super().__init__("polar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Polar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Polar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angularaxis", arg, angularaxis) + self._set_property("bargap", arg, bargap) + self._set_property("barmode", arg, barmode) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("domain", arg, domain) + self._set_property("gridshape", arg, gridshape) + self._set_property("hole", arg, hole) + self._set_property("radialaxis", arg, radialaxis) + self._set_property("sector", arg, sector) + self._set_property("uirevision", arg, uirevision) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_scene.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_scene.py new file mode 100644 index 0000000..2d08ae1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_scene.py @@ -0,0 +1,454 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Scene(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.scene" + _valid_props = { + "annotationdefaults", + "annotations", + "aspectmode", + "aspectratio", + "bgcolor", + "camera", + "domain", + "dragmode", + "hovermode", + "uirevision", + "xaxis", + "yaxis", + "zaxis", + } + + @property + def annotations(self): + """ + The 'annotations' property is a tuple of instances of + Annotation that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.scene.Annotation + - A list or tuple of dicts of string/value properties that + will be passed to the Annotation constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.Annotation] + """ + return self["annotations"] + + @annotations.setter + def annotations(self, val): + self["annotations"] = val + + @property + def annotationdefaults(self): + """ + When used in a template (as + layout.template.layout.scene.annotationdefaults), sets the + default property values to use for elements of + layout.scene.annotations + + The 'annotationdefaults' property is an instance of Annotation + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.Annotation` + - A dict of string/value properties that will be passed + to the Annotation constructor + + Returns + ------- + plotly.graph_objs.layout.scene.Annotation + """ + return self["annotationdefaults"] + + @annotationdefaults.setter + def annotationdefaults(self, val): + self["annotationdefaults"] = val + + @property + def aspectmode(self): + """ + If "cube", this scene's axes are drawn as a cube, regardless of + the axes' ranges. If "data", this scene's axes are drawn in + proportion with the axes' ranges. If "manual", this scene's + axes are drawn in proportion with the input of "aspectratio" + (the default behavior if "aspectratio" is provided). If "auto", + this scene's axes are drawn using the results of "data" except + when one axis is more than four times the size of the two + others, where in that case the results of "cube" are used. + + The 'aspectmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'cube', 'data', 'manual'] + + Returns + ------- + Any + """ + return self["aspectmode"] + + @aspectmode.setter + def aspectmode(self, val): + self["aspectmode"] = val + + @property + def aspectratio(self): + """ + Sets this scene's axis aspectratio. + + The 'aspectratio' property is an instance of Aspectratio + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.Aspectratio` + - A dict of string/value properties that will be passed + to the Aspectratio constructor + + Returns + ------- + plotly.graph_objs.layout.scene.Aspectratio + """ + return self["aspectratio"] + + @aspectratio.setter + def aspectratio(self, val): + self["aspectratio"] = val + + @property + def bgcolor(self): + """ + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def camera(self): + """ + The 'camera' property is an instance of Camera + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.Camera` + - A dict of string/value properties that will be passed + to the Camera constructor + + Returns + ------- + plotly.graph_objs.layout.scene.Camera + """ + return self["camera"] + + @camera.setter + def camera(self, val): + self["camera"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.scene.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def dragmode(self): + """ + Determines the mode of drag interactions for this scene. + + The 'dragmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['orbit', 'turntable', 'zoom', 'pan', False] + + Returns + ------- + Any + """ + return self["dragmode"] + + @dragmode.setter + def dragmode(self, val): + self["dragmode"] = val + + @property + def hovermode(self): + """ + Determines the mode of hover interactions for this scene. + + The 'hovermode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['closest', False] + + Returns + ------- + Any + """ + return self["hovermode"] + + @hovermode.setter + def hovermode(self, val): + self["hovermode"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in camera + attributes. Defaults to `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def xaxis(self): + """ + The 'xaxis' property is an instance of XAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.XAxis` + - A dict of string/value properties that will be passed + to the XAxis constructor + + Returns + ------- + plotly.graph_objs.layout.scene.XAxis + """ + return self["xaxis"] + + @xaxis.setter + def xaxis(self, val): + self["xaxis"] = val + + @property + def yaxis(self): + """ + The 'yaxis' property is an instance of YAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.YAxis` + - A dict of string/value properties that will be passed + to the YAxis constructor + + Returns + ------- + plotly.graph_objs.layout.scene.YAxis + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def zaxis(self): + """ + The 'zaxis' property is an instance of ZAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.ZAxis` + - A dict of string/value properties that will be passed + to the ZAxis constructor + + Returns + ------- + plotly.graph_objs.layout.scene.ZAxis + """ + return self["zaxis"] + + @zaxis.setter + def zaxis(self, val): + self["zaxis"] = val + + @property + def _prop_descriptions(self): + return """\ + annotations + A tuple of + :class:`plotly.graph_objects.layout.scene.Annotation` + instances or dicts with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.scene.annotationdefaults), sets + the default property values to use for elements of + layout.scene.annotations + aspectmode + If "cube", this scene's axes are drawn as a cube, + regardless of the axes' ranges. If "data", this scene's + axes are drawn in proportion with the axes' ranges. If + "manual", this scene's axes are drawn in proportion + with the input of "aspectratio" (the default behavior + if "aspectratio" is provided). If "auto", this scene's + axes are drawn using the results of "data" except when + one axis is more than four times the size of the two + others, where in that case the results of "cube" are + used. + aspectratio + Sets this scene's axis aspectratio. + bgcolor + + camera + :class:`plotly.graph_objects.layout.scene.Camera` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.scene.Domain` + instance or dict with compatible properties + dragmode + Determines the mode of drag interactions for this + scene. + hovermode + Determines the mode of hover interactions for this + scene. + uirevision + Controls persistence of user-driven changes in camera + attributes. Defaults to `layout.uirevision`. + xaxis + :class:`plotly.graph_objects.layout.scene.XAxis` + instance or dict with compatible properties + yaxis + :class:`plotly.graph_objects.layout.scene.YAxis` + instance or dict with compatible properties + zaxis + :class:`plotly.graph_objects.layout.scene.ZAxis` + instance or dict with compatible properties + """ + + def __init__( + self, + arg=None, + annotations=None, + annotationdefaults=None, + aspectmode=None, + aspectratio=None, + bgcolor=None, + camera=None, + domain=None, + dragmode=None, + hovermode=None, + uirevision=None, + xaxis=None, + yaxis=None, + zaxis=None, + **kwargs, + ): + """ + Construct a new Scene object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Scene` + annotations + A tuple of + :class:`plotly.graph_objects.layout.scene.Annotation` + instances or dicts with compatible properties + annotationdefaults + When used in a template (as + layout.template.layout.scene.annotationdefaults), sets + the default property values to use for elements of + layout.scene.annotations + aspectmode + If "cube", this scene's axes are drawn as a cube, + regardless of the axes' ranges. If "data", this scene's + axes are drawn in proportion with the axes' ranges. If + "manual", this scene's axes are drawn in proportion + with the input of "aspectratio" (the default behavior + if "aspectratio" is provided). If "auto", this scene's + axes are drawn using the results of "data" except when + one axis is more than four times the size of the two + others, where in that case the results of "cube" are + used. + aspectratio + Sets this scene's axis aspectratio. + bgcolor + + camera + :class:`plotly.graph_objects.layout.scene.Camera` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.scene.Domain` + instance or dict with compatible properties + dragmode + Determines the mode of drag interactions for this + scene. + hovermode + Determines the mode of hover interactions for this + scene. + uirevision + Controls persistence of user-driven changes in camera + attributes. Defaults to `layout.uirevision`. + xaxis + :class:`plotly.graph_objects.layout.scene.XAxis` + instance or dict with compatible properties + yaxis + :class:`plotly.graph_objects.layout.scene.YAxis` + instance or dict with compatible properties + zaxis + :class:`plotly.graph_objects.layout.scene.ZAxis` + instance or dict with compatible properties + + Returns + ------- + Scene + """ + super().__init__("scene") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Scene +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Scene`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("annotations", arg, annotations) + self._set_property("annotationdefaults", arg, annotationdefaults) + self._set_property("aspectmode", arg, aspectmode) + self._set_property("aspectratio", arg, aspectratio) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("camera", arg, camera) + self._set_property("domain", arg, domain) + self._set_property("dragmode", arg, dragmode) + self._set_property("hovermode", arg, hovermode) + self._set_property("uirevision", arg, uirevision) + self._set_property("xaxis", arg, xaxis) + self._set_property("yaxis", arg, yaxis) + self._set_property("zaxis", arg, zaxis) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_selection.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_selection.py new file mode 100644 index 0000000..3ebf741 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_selection.py @@ -0,0 +1,493 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Selection(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.selection" + _valid_props = { + "line", + "name", + "opacity", + "path", + "templateitemname", + "type", + "x0", + "x1", + "xref", + "y0", + "y1", + "yref", + } + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.selection.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.layout.selection.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the selection. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def path(self): + """ + For `type` "path" - a valid SVG path similar to `shapes.path` + in data coordinates. Allowed segments are: M, L and Z. + + The 'path' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["path"] + + @path.setter + def path(self, val): + self["path"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def type(self): + """ + Specifies the selection type to be drawn. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom SVG path + using `path`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['rect', 'path'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def x0(self): + """ + Sets the selection's starting x position. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def x1(self): + """ + Sets the selection's end x position. + + The 'x1' property accepts values of any type + + Returns + ------- + Any + """ + return self["x1"] + + @x1.setter + def x1(self, val): + self["x1"] = val + + @property + def xref(self): + """ + Sets the selection's x coordinate axis. If set to a x axis id + (e.g. "x" or "x2"), the `x` position refers to a x coordinate. + If set to "paper", the `x` position refers to the distance from + the left of the plotting area in normalized coordinates where 0 + (1) corresponds to the left (right). If set to a x axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the left of the domain of + that axis: e.g., *x2 domain* refers to the domain of the second + x axis and a x position of 0.5 refers to the point between the + left and the right of the domain of the second x axis. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y0(self): + """ + Sets the selection's starting y position. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def y1(self): + """ + Sets the selection's end y position. + + The 'y1' property accepts values of any type + + Returns + ------- + Any + """ + return self["y1"] + + @y1.setter + def y1(self, val): + self["y1"] = val + + @property + def yref(self): + """ + Sets the selection's x coordinate axis. If set to a y axis id + (e.g. "y" or "y2"), the `y` position refers to a y coordinate. + If set to "paper", the `y` position refers to the distance from + the bottom of the plotting area in normalized coordinates where + 0 (1) corresponds to the bottom (top). If set to a y axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the domain of + that axis: e.g., *y2 domain* refers to the domain of the second + y axis and a y position of 0.5 refers to the point between the + bottom and the top of the domain of the second y axis. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.layout.selection.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the selection. + path + For `type` "path" - a valid SVG path similar to + `shapes.path` in data coordinates. Allowed segments + are: M, L and Z. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the selection type to be drawn. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom + SVG path using `path`. + x0 + Sets the selection's starting x position. + x1 + Sets the selection's end x position. + xref + Sets the selection's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y0 + Sets the selection's starting y position. + y1 + Sets the selection's end y position. + yref + Sets the selection's x coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + """ + + def __init__( + self, + arg=None, + line=None, + name=None, + opacity=None, + path=None, + templateitemname=None, + type=None, + x0=None, + x1=None, + xref=None, + y0=None, + y1=None, + yref=None, + **kwargs, + ): + """ + Construct a new Selection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Selection` + line + :class:`plotly.graph_objects.layout.selection.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the selection. + path + For `type` "path" - a valid SVG path similar to + `shapes.path` in data coordinates. Allowed segments + are: M, L and Z. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the selection type to be drawn. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`) and (`x0`,`y1`). If "path", draw a custom + SVG path using `path`. + x0 + Sets the selection's starting x position. + x1 + Sets the selection's end x position. + xref + Sets the selection's x coordinate axis. If set to a x + axis id (e.g. "x" or "x2"), the `x` position refers to + a x coordinate. If set to "paper", the `x` position + refers to the distance from the left of the plotting + area in normalized coordinates where 0 (1) corresponds + to the left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + y0 + Sets the selection's starting y position. + y1 + Sets the selection's end y position. + yref + Sets the selection's x coordinate axis. If set to a y + axis id (e.g. "y" or "y2"), the `y` position refers to + a y coordinate. If set to "paper", the `y` position + refers to the distance from the bottom of the plotting + area in normalized coordinates where 0 (1) corresponds + to the bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + + Returns + ------- + Selection + """ + super().__init__("selections") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Selection +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Selection`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("path", arg, path) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("type", arg, type) + self._set_property("x0", arg, x0) + self._set_property("x1", arg, x1) + self._set_property("xref", arg, xref) + self._set_property("y0", arg, y0) + self._set_property("y1", arg, y1) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_shape.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_shape.py new file mode 100644 index 0000000..8923d1c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_shape.py @@ -0,0 +1,1287 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Shape(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.shape" + _valid_props = { + "editable", + "fillcolor", + "fillrule", + "label", + "layer", + "legend", + "legendgroup", + "legendgrouptitle", + "legendrank", + "legendwidth", + "line", + "name", + "opacity", + "path", + "showlegend", + "templateitemname", + "type", + "visible", + "x0", + "x0shift", + "x1", + "x1shift", + "xanchor", + "xref", + "xsizemode", + "y0", + "y0shift", + "y1", + "y1shift", + "yanchor", + "yref", + "ysizemode", + } + + @property + def editable(self): + """ + Determines whether the shape could be activated for edit or + not. Has no effect when the older editable shapes mode is + enabled via `config.editable` or `config.edits.shapePosition`. + + The 'editable' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["editable"] + + @editable.setter + def editable(self, val): + self["editable"] = val + + @property + def fillcolor(self): + """ + Sets the color filling the shape's interior. Only applies to + closed shapes. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def fillrule(self): + """ + Determines which regions of complex paths constitute the + interior. For more info please visit + https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + + The 'fillrule' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['evenodd', 'nonzero'] + + Returns + ------- + Any + """ + return self["fillrule"] + + @fillrule.setter + def fillrule(self, val): + self["fillrule"] = val + + @property + def label(self): + """ + The 'label' property is an instance of Label + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.shape.Label` + - A dict of string/value properties that will be passed + to the Label constructor + + Returns + ------- + plotly.graph_objs.layout.shape.Label + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def layer(self): + """ + Specifies whether shapes are drawn below gridlines ("below"), + between gridlines and traces ("between") or above traces + ("above"). + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['below', 'above', 'between'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def legend(self): + """ + Sets the reference to a legend to show this shape in. + References to these legends are "legend", "legend2", "legend3", + etc. Settings for these legends are set in the layout, under + `layout.legend`, `layout.legend2`, etc. + + The 'legend' property is an identifier of a particular + subplot, of type 'legend', that may be specified as the string 'legend' + optionally followed by an integer >= 1 + (e.g. 'legend', 'legend1', 'legend2', 'legend3', etc.) + + Returns + ------- + str + """ + return self["legend"] + + @legend.setter + def legend(self, val): + self["legend"] = val + + @property + def legendgroup(self): + """ + Sets the legend group for this shape. Traces and shapes part of + the same legend group hide/show at the same time when toggling + legend items. + + The 'legendgroup' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["legendgroup"] + + @legendgroup.setter + def legendgroup(self, val): + self["legendgroup"] = val + + @property + def legendgrouptitle(self): + """ + The 'legendgrouptitle' property is an instance of Legendgrouptitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.shape.Legendgrouptitle` + - A dict of string/value properties that will be passed + to the Legendgrouptitle constructor + + Returns + ------- + plotly.graph_objs.layout.shape.Legendgrouptitle + """ + return self["legendgrouptitle"] + + @legendgrouptitle.setter + def legendgrouptitle(self, val): + self["legendgrouptitle"] = val + + @property + def legendrank(self): + """ + Sets the legend rank for this shape. Items and groups with + smaller ranks are presented on top/left side while with + "reversed" `legend.traceorder` they are on bottom/right side. + The default legendrank is 1000, so that you can use ranks less + than 1000 to place certain items before all unranked items, and + ranks greater than 1000 to go after all unranked items. When + having unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and layout. + + The 'legendrank' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["legendrank"] + + @legendrank.setter + def legendrank(self, val): + self["legendrank"] = val + + @property + def legendwidth(self): + """ + Sets the width (in px or fraction) of the legend for this + shape. + + The 'legendwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["legendwidth"] + + @legendwidth.setter + def legendwidth(self, val): + self["legendwidth"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.shape.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.layout.shape.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the shape. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def path(self): + """ + For `type` "path" - a valid SVG path with the pixel values + replaced by data values in `xsizemode`/`ysizemode` being + "scaled" and taken unmodified as pixels relative to `xanchor` + and `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not relative. + So the allowed segments are: M, L, H, V, Q, C, T, S, and Z arcs + (A) are not allowed because radius rx and ry are relative. In + the future we could consider supporting relative commands, but + we would have to decide on how to handle date and log axes. + Note that even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. no + chained "polybezier" commands - specify the segment type for + each one. On category axes, values are numbers scaled to the + serial numbers of categories because using the categories + themselves there would be no way to describe fractional + positions On data axes: because space and T are both normal + components of path strings, we can't use either to separate + date from time parts. Therefore we'll use underscore for this + purpose: 2015-02-21_13:45:56.789 + + The 'path' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["path"] + + @path.setter + def path(self, val): + self["path"] = val + + @property + def showlegend(self): + """ + Determines whether or not this shape is shown in the legend. + + The 'showlegend' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showlegend"] + + @showlegend.setter + def showlegend(self, val): + self["showlegend"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def type(self): + """ + Specifies the shape type to be drawn. If "line", a line is + drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect to the axes' + sizing mode. If "circle", a circle is drawn from + ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius (|(`x0`+`x1`)/2 - + `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with respect to the axes' sizing + mode. If "rect", a rectangle is drawn linking (`x0`,`y0`), + (`x1`,`y0`), (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect + to the axes' sizing mode. If "path", draw a custom SVG path + using `path`. with respect to the axes' sizing mode. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circle', 'rect', 'path', 'line'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + Determines whether or not this shape is visible. If + "legendonly", the shape is not drawn, but can appear as a + legend item (provided that the legend itself is visible). + + The 'visible' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'legendonly'] + + Returns + ------- + Any + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x0(self): + """ + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + + The 'x0' property accepts values of any type + + Returns + ------- + Any + """ + return self["x0"] + + @x0.setter + def x0(self, val): + self["x0"] = val + + @property + def x0shift(self): + """ + Shifts `x0` away from the center of the category when `xref` is + a "category" or "multicategory" axis. -0.5 corresponds to the + start of the category and 0.5 corresponds to the end of the + category. + + The 'x0shift' property is a number and may be specified as: + - An int or float in the interval [-1, 1] + + Returns + ------- + int|float + """ + return self["x0shift"] + + @x0shift.setter + def x0shift(self, val): + self["x0shift"] = val + + @property + def x1(self): + """ + Sets the shape's end x position. See `type` and `xsizemode` for + more info. + + The 'x1' property accepts values of any type + + Returns + ------- + Any + """ + return self["x1"] + + @x1.setter + def x1(self, val): + self["x1"] = val + + @property + def x1shift(self): + """ + Shifts `x1` away from the center of the category when `xref` is + a "category" or "multicategory" axis. -0.5 corresponds to the + start of the category and 0.5 corresponds to the end of the + category. + + The 'x1shift' property is a number and may be specified as: + - An int or float in the interval [-1, 1] + + Returns + ------- + int|float + """ + return self["x1shift"] + + @x1shift.setter + def x1shift(self, val): + self["x1shift"] = val + + @property + def xanchor(self): + """ + Only relevant in conjunction with `xsizemode` set to "pixel". + Specifies the anchor point on the x axis to which `x0`, `x1` + and x coordinates within `path` are relative to. E.g. useful to + attach a pixel sized shape to a certain data value. No effect + when `xsizemode` not set to "pixel". + + The 'xanchor' property accepts values of any type + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xref(self): + """ + Sets the shape's x coordinate axis. If set to a x axis id (e.g. + "x" or "x2"), the `x` position refers to a x coordinate. If set + to "paper", the `x` position refers to the distance from the + left of the plotting area in normalized coordinates where 0 (1) + corresponds to the left (right). If set to a x axis ID followed + by "domain" (separated by a space), the position behaves like + for "paper", but refers to the distance in fractions of the + domain length from the left of the domain of that axis: e.g., + *x2 domain* refers to the domain of the second x axis and a x + position of 0.5 refers to the point between the left and the + right of the domain of the second x axis. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def xsizemode(self): + """ + Sets the shapes's sizing mode along the x axis. If set to + "scaled", `x0`, `x1` and x coordinates within `path` refer to + data values on the x axis or a fraction of the plot area's + width (`xref` set to "paper"). If set to "pixel", `xanchor` + specifies the x position in terms of data or plot fraction but + `x0`, `x1` and x coordinates within `path` are pixels relative + to `xanchor`. This way, the shape can have a fixed width while + maintaining a position relative to data or plot fraction. + + The 'xsizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['scaled', 'pixel'] + + Returns + ------- + Any + """ + return self["xsizemode"] + + @xsizemode.setter + def xsizemode(self, val): + self["xsizemode"] = val + + @property + def y0(self): + """ + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + + The 'y0' property accepts values of any type + + Returns + ------- + Any + """ + return self["y0"] + + @y0.setter + def y0(self, val): + self["y0"] = val + + @property + def y0shift(self): + """ + Shifts `y0` away from the center of the category when `yref` is + a "category" or "multicategory" axis. -0.5 corresponds to the + start of the category and 0.5 corresponds to the end of the + category. + + The 'y0shift' property is a number and may be specified as: + - An int or float in the interval [-1, 1] + + Returns + ------- + int|float + """ + return self["y0shift"] + + @y0shift.setter + def y0shift(self, val): + self["y0shift"] = val + + @property + def y1(self): + """ + Sets the shape's end y position. See `type` and `ysizemode` for + more info. + + The 'y1' property accepts values of any type + + Returns + ------- + Any + """ + return self["y1"] + + @y1.setter + def y1(self, val): + self["y1"] = val + + @property + def y1shift(self): + """ + Shifts `y1` away from the center of the category when `yref` is + a "category" or "multicategory" axis. -0.5 corresponds to the + start of the category and 0.5 corresponds to the end of the + category. + + The 'y1shift' property is a number and may be specified as: + - An int or float in the interval [-1, 1] + + Returns + ------- + int|float + """ + return self["y1shift"] + + @y1shift.setter + def y1shift(self, val): + self["y1shift"] = val + + @property + def yanchor(self): + """ + Only relevant in conjunction with `ysizemode` set to "pixel". + Specifies the anchor point on the y axis to which `y0`, `y1` + and y coordinates within `path` are relative to. E.g. useful to + attach a pixel sized shape to a certain data value. No effect + when `ysizemode` not set to "pixel". + + The 'yanchor' property accepts values of any type + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def yref(self): + """ + Sets the shape's y coordinate axis. If set to a y axis id (e.g. + "y" or "y2"), the `y` position refers to a y coordinate. If set + to "paper", the `y` position refers to the distance from the + bottom of the plotting area in normalized coordinates where 0 + (1) corresponds to the bottom (top). If set to a y axis ID + followed by "domain" (separated by a space), the position + behaves like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the domain of + that axis: e.g., *y2 domain* refers to the domain of the second + y axis and a y position of 0.5 refers to the point between the + bottom and the top of the domain of the second y axis. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['paper'] + - A string that matches one of the following regular expressions: + ['^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def ysizemode(self): + """ + Sets the shapes's sizing mode along the y axis. If set to + "scaled", `y0`, `y1` and y coordinates within `path` refer to + data values on the y axis or a fraction of the plot area's + height (`yref` set to "paper"). If set to "pixel", `yanchor` + specifies the y position in terms of data or plot fraction but + `y0`, `y1` and y coordinates within `path` are pixels relative + to `yanchor`. This way, the shape can have a fixed height while + maintaining a position relative to data or plot fraction. + + The 'ysizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['scaled', 'pixel'] + + Returns + ------- + Any + """ + return self["ysizemode"] + + @ysizemode.setter + def ysizemode(self, val): + self["ysizemode"] = val + + @property + def _prop_descriptions(self): + return """\ + editable + Determines whether the shape could be activated for + edit or not. Has no effect when the older editable + shapes mode is enabled via `config.editable` or + `config.edits.shapePosition`. + fillcolor + Sets the color filling the shape's interior. Only + applies to closed shapes. + fillrule + Determines which regions of complex paths constitute + the interior. For more info please visit + https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + label + :class:`plotly.graph_objects.layout.shape.Label` + instance or dict with compatible properties + layer + Specifies whether shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or + above traces ("above"). + legend + Sets the reference to a legend to show this shape in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this shape. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.layout.shape.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this shape. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this shape. + line + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the pixel + values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and taken + unmodified as pixels relative to `xanchor` and + `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not + relative. So the allowed segments are: M, L, H, V, Q, + C, T, S, and Z arcs (A) are not allowed because radius + rx and ry are relative. In the future we could consider + supporting relative commands, but we would have to + decide on how to handle date and log axes. Note that + even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. + no chained "polybezier" commands - specify the segment + type for each one. On category axes, values are numbers + scaled to the serial numbers of categories because + using the categories themselves there would be no way + to describe fractional positions On data axes: because + space and T are both normal components of path strings, + we can't use either to separate date from time parts. + Therefore we'll use underscore for this purpose: + 2015-02-21_13:45:56.789 + showlegend + Determines whether or not this shape is shown in the + legend. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If "line", a line + is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect + to the axes' sizing mode. If "circle", a circle is + drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with + respect to the axes' sizing mode. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to + the axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' sizing + mode. + visible + Determines whether or not this shape is visible. If + "legendonly", the shape is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x0 + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + x0shift + Shifts `x0` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + x1shift + Shifts `x1` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + xanchor + Only relevant in conjunction with `xsizemode` set to + "pixel". Specifies the anchor point on the x axis to + which `x0`, `x1` and x coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `xsizemode` not + set to "pixel". + xref + Sets the shape's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xsizemode + Sets the shapes's sizing mode along the x axis. If set + to "scaled", `x0`, `x1` and x coordinates within `path` + refer to data values on the x axis or a fraction of the + plot area's width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in terms of + data or plot fraction but `x0`, `x1` and x coordinates + within `path` are pixels relative to `xanchor`. This + way, the shape can have a fixed width while maintaining + a position relative to data or plot fraction. + y0 + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + y0shift + Shifts `y0` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + y1shift + Shifts `y1` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + yanchor + Only relevant in conjunction with `ysizemode` set to + "pixel". Specifies the anchor point on the y axis to + which `y0`, `y1` and y coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `ysizemode` not + set to "pixel". + yref + Sets the shape's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + ysizemode + Sets the shapes's sizing mode along the y axis. If set + to "scaled", `y0`, `y1` and y coordinates within `path` + refer to data values on the y axis or a fraction of the + plot area's height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in terms of + data or plot fraction but `y0`, `y1` and y coordinates + within `path` are pixels relative to `yanchor`. This + way, the shape can have a fixed height while + maintaining a position relative to data or plot + fraction. + """ + + def __init__( + self, + arg=None, + editable=None, + fillcolor=None, + fillrule=None, + label=None, + layer=None, + legend=None, + legendgroup=None, + legendgrouptitle=None, + legendrank=None, + legendwidth=None, + line=None, + name=None, + opacity=None, + path=None, + showlegend=None, + templateitemname=None, + type=None, + visible=None, + x0=None, + x0shift=None, + x1=None, + x1shift=None, + xanchor=None, + xref=None, + xsizemode=None, + y0=None, + y0shift=None, + y1=None, + y1shift=None, + yanchor=None, + yref=None, + ysizemode=None, + **kwargs, + ): + """ + Construct a new Shape object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Shape` + editable + Determines whether the shape could be activated for + edit or not. Has no effect when the older editable + shapes mode is enabled via `config.editable` or + `config.edits.shapePosition`. + fillcolor + Sets the color filling the shape's interior. Only + applies to closed shapes. + fillrule + Determines which regions of complex paths constitute + the interior. For more info please visit + https://developer.mozilla.org/en- + US/docs/Web/SVG/Attribute/fill-rule + label + :class:`plotly.graph_objects.layout.shape.Label` + instance or dict with compatible properties + layer + Specifies whether shapes are drawn below gridlines + ("below"), between gridlines and traces ("between") or + above traces ("above"). + legend + Sets the reference to a legend to show this shape in. + References to these legends are "legend", "legend2", + "legend3", etc. Settings for these legends are set in + the layout, under `layout.legend`, `layout.legend2`, + etc. + legendgroup + Sets the legend group for this shape. Traces and shapes + part of the same legend group hide/show at the same + time when toggling legend items. + legendgrouptitle + :class:`plotly.graph_objects.layout.shape.Legendgroupti + tle` instance or dict with compatible properties + legendrank + Sets the legend rank for this shape. Items and groups + with smaller ranks are presented on top/left side while + with "reversed" `legend.traceorder` they are on + bottom/right side. The default legendrank is 1000, so + that you can use ranks less than 1000 to place certain + items before all unranked items, and ranks greater than + 1000 to go after all unranked items. When having + unranked or equal rank items shapes would be displayed + after traces i.e. according to their order in data and + layout. + legendwidth + Sets the width (in px or fraction) of the legend for + this shape. + line + :class:`plotly.graph_objects.layout.shape.Line` + instance or dict with compatible properties + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the shape. + path + For `type` "path" - a valid SVG path with the pixel + values replaced by data values in + `xsizemode`/`ysizemode` being "scaled" and taken + unmodified as pixels relative to `xanchor` and + `yanchor` in case of "pixel" size mode. There are a few + restrictions / quirks only absolute instructions, not + relative. So the allowed segments are: M, L, H, V, Q, + C, T, S, and Z arcs (A) are not allowed because radius + rx and ry are relative. In the future we could consider + supporting relative commands, but we would have to + decide on how to handle date and log axes. Note that + even as is, Q and C Bezier paths that are smooth on + linear axes may not be smooth on log, and vice versa. + no chained "polybezier" commands - specify the segment + type for each one. On category axes, values are numbers + scaled to the serial numbers of categories because + using the categories themselves there would be no way + to describe fractional positions On data axes: because + space and T are both normal components of path strings, + we can't use either to separate date from time parts. + Therefore we'll use underscore for this purpose: + 2015-02-21_13:45:56.789 + showlegend + Determines whether or not this shape is shown in the + legend. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Specifies the shape type to be drawn. If "line", a line + is drawn from (`x0`,`y0`) to (`x1`,`y1`) with respect + to the axes' sizing mode. If "circle", a circle is + drawn from ((`x0`+`x1`)/2, (`y0`+`y1`)/2)) with radius + (|(`x0`+`x1`)/2 - `x0`|, |(`y0`+`y1`)/2 -`y0`)|) with + respect to the axes' sizing mode. If "rect", a + rectangle is drawn linking (`x0`,`y0`), (`x1`,`y0`), + (`x1`,`y1`), (`x0`,`y1`), (`x0`,`y0`) with respect to + the axes' sizing mode. If "path", draw a custom SVG + path using `path`. with respect to the axes' sizing + mode. + visible + Determines whether or not this shape is visible. If + "legendonly", the shape is not drawn, but can appear as + a legend item (provided that the legend itself is + visible). + x0 + Sets the shape's starting x position. See `type` and + `xsizemode` for more info. + x0shift + Shifts `x0` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + x1 + Sets the shape's end x position. See `type` and + `xsizemode` for more info. + x1shift + Shifts `x1` away from the center of the category when + `xref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + xanchor + Only relevant in conjunction with `xsizemode` set to + "pixel". Specifies the anchor point on the x axis to + which `x0`, `x1` and x coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `xsizemode` not + set to "pixel". + xref + Sets the shape's x coordinate axis. If set to a x axis + id (e.g. "x" or "x2"), the `x` position refers to a x + coordinate. If set to "paper", the `x` position refers + to the distance from the left of the plotting area in + normalized coordinates where 0 (1) corresponds to the + left (right). If set to a x axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the left of the + domain of that axis: e.g., *x2 domain* refers to the + domain of the second x axis and a x position of 0.5 + refers to the point between the left and the right of + the domain of the second x axis. + xsizemode + Sets the shapes's sizing mode along the x axis. If set + to "scaled", `x0`, `x1` and x coordinates within `path` + refer to data values on the x axis or a fraction of the + plot area's width (`xref` set to "paper"). If set to + "pixel", `xanchor` specifies the x position in terms of + data or plot fraction but `x0`, `x1` and x coordinates + within `path` are pixels relative to `xanchor`. This + way, the shape can have a fixed width while maintaining + a position relative to data or plot fraction. + y0 + Sets the shape's starting y position. See `type` and + `ysizemode` for more info. + y0shift + Shifts `y0` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + y1 + Sets the shape's end y position. See `type` and + `ysizemode` for more info. + y1shift + Shifts `y1` away from the center of the category when + `yref` is a "category" or "multicategory" axis. -0.5 + corresponds to the start of the category and 0.5 + corresponds to the end of the category. + yanchor + Only relevant in conjunction with `ysizemode` set to + "pixel". Specifies the anchor point on the y axis to + which `y0`, `y1` and y coordinates within `path` are + relative to. E.g. useful to attach a pixel sized shape + to a certain data value. No effect when `ysizemode` not + set to "pixel". + yref + Sets the shape's y coordinate axis. If set to a y axis + id (e.g. "y" or "y2"), the `y` position refers to a y + coordinate. If set to "paper", the `y` position refers + to the distance from the bottom of the plotting area in + normalized coordinates where 0 (1) corresponds to the + bottom (top). If set to a y axis ID followed by + "domain" (separated by a space), the position behaves + like for "paper", but refers to the distance in + fractions of the domain length from the bottom of the + domain of that axis: e.g., *y2 domain* refers to the + domain of the second y axis and a y position of 0.5 + refers to the point between the bottom and the top of + the domain of the second y axis. + ysizemode + Sets the shapes's sizing mode along the y axis. If set + to "scaled", `y0`, `y1` and y coordinates within `path` + refer to data values on the y axis or a fraction of the + plot area's height (`yref` set to "paper"). If set to + "pixel", `yanchor` specifies the y position in terms of + data or plot fraction but `y0`, `y1` and y coordinates + within `path` are pixels relative to `yanchor`. This + way, the shape can have a fixed height while + maintaining a position relative to data or plot + fraction. + + Returns + ------- + Shape + """ + super().__init__("shapes") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Shape +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Shape`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("editable", arg, editable) + self._set_property("fillcolor", arg, fillcolor) + self._set_property("fillrule", arg, fillrule) + self._set_property("label", arg, label) + self._set_property("layer", arg, layer) + self._set_property("legend", arg, legend) + self._set_property("legendgroup", arg, legendgroup) + self._set_property("legendgrouptitle", arg, legendgrouptitle) + self._set_property("legendrank", arg, legendrank) + self._set_property("legendwidth", arg, legendwidth) + self._set_property("line", arg, line) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("path", arg, path) + self._set_property("showlegend", arg, showlegend) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._set_property("x0", arg, x0) + self._set_property("x0shift", arg, x0shift) + self._set_property("x1", arg, x1) + self._set_property("x1shift", arg, x1shift) + self._set_property("xanchor", arg, xanchor) + self._set_property("xref", arg, xref) + self._set_property("xsizemode", arg, xsizemode) + self._set_property("y0", arg, y0) + self._set_property("y0shift", arg, y0shift) + self._set_property("y1", arg, y1) + self._set_property("y1shift", arg, y1shift) + self._set_property("yanchor", arg, yanchor) + self._set_property("yref", arg, yref) + self._set_property("ysizemode", arg, ysizemode) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_slider.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_slider.py new file mode 100644 index 0000000..e6d0a2f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_slider.py @@ -0,0 +1,786 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Slider(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.slider" + _valid_props = { + "active", + "activebgcolor", + "bgcolor", + "bordercolor", + "borderwidth", + "currentvalue", + "font", + "len", + "lenmode", + "minorticklen", + "name", + "pad", + "stepdefaults", + "steps", + "templateitemname", + "tickcolor", + "ticklen", + "tickwidth", + "transition", + "visible", + "x", + "xanchor", + "y", + "yanchor", + } + + @property + def active(self): + """ + Determines which button (by index starting from 0) is + considered active. + + The 'active' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["active"] + + @active.setter + def active(self, val): + self["active"] = val + + @property + def activebgcolor(self): + """ + Sets the background color of the slider grip while dragging. + + The 'activebgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["activebgcolor"] + + @activebgcolor.setter + def activebgcolor(self, val): + self["activebgcolor"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the slider. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the slider. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the slider. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def currentvalue(self): + """ + The 'currentvalue' property is an instance of Currentvalue + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.slider.Currentvalue` + - A dict of string/value properties that will be passed + to the Currentvalue constructor + + Returns + ------- + plotly.graph_objs.layout.slider.Currentvalue + """ + return self["currentvalue"] + + @currentvalue.setter + def currentvalue(self, val): + self["currentvalue"] = val + + @property + def font(self): + """ + Sets the font of the slider step labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.slider.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.slider.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def len(self): + """ + Sets the length of the slider This measure excludes the padding + of both ends. That is, the slider's length is this length minus + the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this slider length is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minorticklen(self): + """ + Sets the length in pixels of minor step tick marks + + The 'minorticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minorticklen"] + + @minorticklen.setter + def minorticklen(self, val): + self["minorticklen"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def pad(self): + """ + Set the padding of the slider component along each side. + + The 'pad' property is an instance of Pad + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.slider.Pad` + - A dict of string/value properties that will be passed + to the Pad constructor + + Returns + ------- + plotly.graph_objs.layout.slider.Pad + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def steps(self): + """ + The 'steps' property is a tuple of instances of + Step that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.slider.Step + - A list or tuple of dicts of string/value properties that + will be passed to the Step constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.slider.Step] + """ + return self["steps"] + + @steps.setter + def steps(self, val): + self["steps"] = val + + @property + def stepdefaults(self): + """ + When used in a template (as + layout.template.layout.slider.stepdefaults), sets the default + property values to use for elements of layout.slider.steps + + The 'stepdefaults' property is an instance of Step + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.slider.Step` + - A dict of string/value properties that will be passed + to the Step constructor + + Returns + ------- + plotly.graph_objs.layout.slider.Step + """ + return self["stepdefaults"] + + @stepdefaults.setter + def stepdefaults(self, val): + self["stepdefaults"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def tickcolor(self): + """ + Sets the color of the border enclosing the slider. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def ticklen(self): + """ + Sets the length in pixels of step tick marks + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def transition(self): + """ + The 'transition' property is an instance of Transition + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.slider.Transition` + - A dict of string/value properties that will be passed + to the Transition constructor + + Returns + ------- + plotly.graph_objs.layout.slider.Transition + """ + return self["transition"] + + @transition.setter + def transition(self, val): + self["transition"] = val + + @property + def visible(self): + """ + Determines whether or not the slider is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x position (in normalized coordinates) of the slider. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the slider's horizontal position anchor. This anchor binds + the `x` position to the "left", "center" or "right" of the + range selector. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def y(self): + """ + Sets the y position (in normalized coordinates) of the slider. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the slider's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + range selector. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def _prop_descriptions(self): + return """\ + active + Determines which button (by index starting from 0) is + considered active. + activebgcolor + Sets the background color of the slider grip while + dragging. + bgcolor + Sets the background color of the slider. + bordercolor + Sets the color of the border enclosing the slider. + borderwidth + Sets the width (in px) of the border enclosing the + slider. + currentvalue + :class:`plotly.graph_objects.layout.slider.Currentvalue + ` instance or dict with compatible properties + font + Sets the font of the slider step labels. + len + Sets the length of the slider This measure excludes the + padding of both ends. That is, the slider's length is + this length minus the padding on both ends. + lenmode + Determines whether this slider length is set in units + of plot "fraction" or in *pixels. Use `len` to set the + value. + minorticklen + Sets the length in pixels of minor step tick marks + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Set the padding of the slider component along each + side. + steps + A tuple of + :class:`plotly.graph_objects.layout.slider.Step` + instances or dicts with compatible properties + stepdefaults + When used in a template (as + layout.template.layout.slider.stepdefaults), sets the + default property values to use for elements of + layout.slider.steps + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickcolor + Sets the color of the border enclosing the slider. + ticklen + Sets the length in pixels of step tick marks + tickwidth + Sets the tick width (in px). + transition + :class:`plotly.graph_objects.layout.slider.Transition` + instance or dict with compatible properties + visible + Determines whether or not the slider is visible. + x + Sets the x position (in normalized coordinates) of the + slider. + xanchor + Sets the slider's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + slider. + yanchor + Sets the slider's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + """ + + def __init__( + self, + arg=None, + active=None, + activebgcolor=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + currentvalue=None, + font=None, + len=None, + lenmode=None, + minorticklen=None, + name=None, + pad=None, + steps=None, + stepdefaults=None, + templateitemname=None, + tickcolor=None, + ticklen=None, + tickwidth=None, + transition=None, + visible=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs, + ): + """ + Construct a new Slider object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Slider` + active + Determines which button (by index starting from 0) is + considered active. + activebgcolor + Sets the background color of the slider grip while + dragging. + bgcolor + Sets the background color of the slider. + bordercolor + Sets the color of the border enclosing the slider. + borderwidth + Sets the width (in px) of the border enclosing the + slider. + currentvalue + :class:`plotly.graph_objects.layout.slider.Currentvalue + ` instance or dict with compatible properties + font + Sets the font of the slider step labels. + len + Sets the length of the slider This measure excludes the + padding of both ends. That is, the slider's length is + this length minus the padding on both ends. + lenmode + Determines whether this slider length is set in units + of plot "fraction" or in *pixels. Use `len` to set the + value. + minorticklen + Sets the length in pixels of minor step tick marks + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Set the padding of the slider component along each + side. + steps + A tuple of + :class:`plotly.graph_objects.layout.slider.Step` + instances or dicts with compatible properties + stepdefaults + When used in a template (as + layout.template.layout.slider.stepdefaults), sets the + default property values to use for elements of + layout.slider.steps + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickcolor + Sets the color of the border enclosing the slider. + ticklen + Sets the length in pixels of step tick marks + tickwidth + Sets the tick width (in px). + transition + :class:`plotly.graph_objects.layout.slider.Transition` + instance or dict with compatible properties + visible + Determines whether or not the slider is visible. + x + Sets the x position (in normalized coordinates) of the + slider. + xanchor + Sets the slider's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + slider. + yanchor + Sets the slider's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + + Returns + ------- + Slider + """ + super().__init__("sliders") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Slider +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Slider`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("active", arg, active) + self._set_property("activebgcolor", arg, activebgcolor) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("currentvalue", arg, currentvalue) + self._set_property("font", arg, font) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minorticklen", arg, minorticklen) + self._set_property("name", arg, name) + self._set_property("pad", arg, pad) + self._set_property("steps", arg, steps) + self._set_property("stepdefaults", arg, stepdefaults) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("transition", arg, transition) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_smith.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_smith.py new file mode 100644 index 0000000..061e679 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_smith.py @@ -0,0 +1,166 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Smith(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.smith" + _valid_props = {"bgcolor", "domain", "imaginaryaxis", "realaxis"} + + @property + def bgcolor(self): + """ + Set the background color of the subplot + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.smith.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.smith.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def imaginaryaxis(self): + """ + The 'imaginaryaxis' property is an instance of Imaginaryaxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.smith.Imaginaryaxis` + - A dict of string/value properties that will be passed + to the Imaginaryaxis constructor + + Returns + ------- + plotly.graph_objs.layout.smith.Imaginaryaxis + """ + return self["imaginaryaxis"] + + @imaginaryaxis.setter + def imaginaryaxis(self, val): + self["imaginaryaxis"] = val + + @property + def realaxis(self): + """ + The 'realaxis' property is an instance of Realaxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.smith.Realaxis` + - A dict of string/value properties that will be passed + to the Realaxis constructor + + Returns + ------- + plotly.graph_objs.layout.smith.Realaxis + """ + return self["realaxis"] + + @realaxis.setter + def realaxis(self, val): + self["realaxis"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Set the background color of the subplot + domain + :class:`plotly.graph_objects.layout.smith.Domain` + instance or dict with compatible properties + imaginaryaxis + :class:`plotly.graph_objects.layout.smith.Imaginaryaxis + ` instance or dict with compatible properties + realaxis + :class:`plotly.graph_objects.layout.smith.Realaxis` + instance or dict with compatible properties + """ + + def __init__( + self, + arg=None, + bgcolor=None, + domain=None, + imaginaryaxis=None, + realaxis=None, + **kwargs, + ): + """ + Construct a new Smith object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Smith` + bgcolor + Set the background color of the subplot + domain + :class:`plotly.graph_objects.layout.smith.Domain` + instance or dict with compatible properties + imaginaryaxis + :class:`plotly.graph_objects.layout.smith.Imaginaryaxis + ` instance or dict with compatible properties + realaxis + :class:`plotly.graph_objects.layout.smith.Realaxis` + instance or dict with compatible properties + + Returns + ------- + Smith + """ + super().__init__("smith") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Smith +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Smith`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("domain", arg, domain) + self._set_property("imaginaryaxis", arg, imaginaryaxis) + self._set_property("realaxis", arg, realaxis) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_template.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_template.py new file mode 100644 index 0000000..90eb3f6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_template.py @@ -0,0 +1,133 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy +import warnings + + +class Template(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.template" + _valid_props = {"data", "layout"} + + @property + def data(self): + """ + The 'data' property is an instance of Data + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.template.Data` + - A dict of string/value properties that will be passed + to the Data constructor + + Returns + ------- + plotly.graph_objs.layout.template.Data + """ + return self["data"] + + @data.setter + def data(self, val): + self["data"] = val + + @property + def layout(self): + """ + The 'layout' property is an instance of Layout + that may be specified as: + - An instance of :class:`plotly.graph_objs.Layout` + - A dict of string/value properties that will be passed + to the Layout constructor + + Returns + ------- + plotly.graph_objs.layout.template.Layout + """ + return self["layout"] + + @layout.setter + def layout(self, val): + self["layout"] = val + + @property + def _prop_descriptions(self): + return """\ + data + :class:`plotly.graph_objects.layout.template.Data` + instance or dict with compatible properties + layout + :class:`plotly.graph_objects.Layout` instance or dict + with compatible properties + """ + + def __init__(self, arg=None, data=None, layout=None, **kwargs): + """ + Construct a new Template object + + Default attributes to be applied to the plot. This should be a + dict with format: `{'layout': layoutTemplate, 'data': + {trace_type: [traceTemplate, ...], ...}}` where + `layoutTemplate` is a dict matching the structure of + `figure.layout` and `traceTemplate` is a dict matching the + structure of the trace with type `trace_type` (e.g. 'scatter'). + Alternatively, this may be specified as an instance of + plotly.graph_objs.layout.Template. Trace templates are applied + cyclically to traces of each type. Container arrays (eg + `annotations`) have special handling: An object ending in + `defaults` (eg `annotationdefaults`) is applied to each array + item. But if an item has a `templateitemname` key we look in + the template array for an item with matching `name` and apply + that instead. If no matching `name` is found we mark the item + invisible. Any named template item not referenced is appended + to the end of the array, so this can be used to add a watermark + annotation or a logo image, for example. To omit one of these + items on the plot, make an item with matching + `templateitemname` and `visible: false`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Template` + data + :class:`plotly.graph_objects.layout.template.Data` + instance or dict with compatible properties + layout + :class:`plotly.graph_objects.Layout` instance or dict + with compatible properties + + Returns + ------- + Template + """ + super().__init__("template") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Template +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Template`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + # Template.data contains a 'scattermapbox' key, which causes a + # go.Scattermapbox trace object to be created during validation. + # In order to prevent false deprecation warnings from surfacing, + # we suppress deprecation warnings for this line only. + with warnings.catch_warnings(): + warnings.filterwarnings("ignore", category=DeprecationWarning) + self._set_property("data", arg, data) + self._set_property("layout", arg, layout) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_ternary.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_ternary.py new file mode 100644 index 0000000..c8cb58f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_ternary.py @@ -0,0 +1,250 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Ternary(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.ternary" + _valid_props = {"aaxis", "baxis", "bgcolor", "caxis", "domain", "sum", "uirevision"} + + @property + def aaxis(self): + """ + The 'aaxis' property is an instance of Aaxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.Aaxis` + - A dict of string/value properties that will be passed + to the Aaxis constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.Aaxis + """ + return self["aaxis"] + + @aaxis.setter + def aaxis(self, val): + self["aaxis"] = val + + @property + def baxis(self): + """ + The 'baxis' property is an instance of Baxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.Baxis` + - A dict of string/value properties that will be passed + to the Baxis constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.Baxis + """ + return self["baxis"] + + @baxis.setter + def baxis(self, val): + self["baxis"] = val + + @property + def bgcolor(self): + """ + Set the background color of the subplot + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def caxis(self): + """ + The 'caxis' property is an instance of Caxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.Caxis` + - A dict of string/value properties that will be passed + to the Caxis constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.Caxis + """ + return self["caxis"] + + @caxis.setter + def caxis(self, val): + self["caxis"] = val + + @property + def domain(self): + """ + The 'domain' property is an instance of Domain + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.Domain` + - A dict of string/value properties that will be passed + to the Domain constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.Domain + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def sum(self): + """ + The number each triplet should sum to, and the maximum range of + each axis + + The 'sum' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sum"] + + @sum.setter + def sum(self, val): + self["sum"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `min` and + `title`, if not overridden in the individual axes. Defaults to + `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def _prop_descriptions(self): + return """\ + aaxis + :class:`plotly.graph_objects.layout.ternary.Aaxis` + instance or dict with compatible properties + baxis + :class:`plotly.graph_objects.layout.ternary.Baxis` + instance or dict with compatible properties + bgcolor + Set the background color of the subplot + caxis + :class:`plotly.graph_objects.layout.ternary.Caxis` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.ternary.Domain` + instance or dict with compatible properties + sum + The number each triplet should sum to, and the maximum + range of each axis + uirevision + Controls persistence of user-driven changes in axis + `min` and `title`, if not overridden in the individual + axes. Defaults to `layout.uirevision`. + """ + + def __init__( + self, + arg=None, + aaxis=None, + baxis=None, + bgcolor=None, + caxis=None, + domain=None, + sum=None, + uirevision=None, + **kwargs, + ): + """ + Construct a new Ternary object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Ternary` + aaxis + :class:`plotly.graph_objects.layout.ternary.Aaxis` + instance or dict with compatible properties + baxis + :class:`plotly.graph_objects.layout.ternary.Baxis` + instance or dict with compatible properties + bgcolor + Set the background color of the subplot + caxis + :class:`plotly.graph_objects.layout.ternary.Caxis` + instance or dict with compatible properties + domain + :class:`plotly.graph_objects.layout.ternary.Domain` + instance or dict with compatible properties + sum + The number each triplet should sum to, and the maximum + range of each axis + uirevision + Controls persistence of user-driven changes in axis + `min` and `title`, if not overridden in the individual + axes. Defaults to `layout.uirevision`. + + Returns + ------- + Ternary + """ + super().__init__("ternary") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Ternary +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Ternary`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("aaxis", arg, aaxis) + self._set_property("baxis", arg, baxis) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("caxis", arg, caxis) + self._set_property("domain", arg, domain) + self._set_property("sum", arg, sum) + self._set_property("uirevision", arg, uirevision) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_title.py new file mode 100644 index 0000000..47301d8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_title.py @@ -0,0 +1,450 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.title" + _valid_props = { + "automargin", + "font", + "pad", + "subtitle", + "text", + "x", + "xanchor", + "xref", + "y", + "yanchor", + "yref", + } + + @property + def automargin(self): + """ + Determines whether the title can automatically push the figure + margins. If `yref='paper'` then the margin will expand to + ensure that the title doesn’t overlap with the edges of the + container. If `yref='container'` then the margins will ensure + that the title doesn’t overlap with the plot area, tick labels, + and axis titles. If `automargin=true` and the margins need to + be expanded, then y will be set to a default 1 and yanchor will + be set to an appropriate default to ensure that minimal margin + space is needed. Note that when `yref='paper'`, only 1 or 0 are + allowed y values. Invalid values will be reset to the default + 1. + + The 'automargin' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["automargin"] + + @automargin.setter + def automargin(self, val): + self["automargin"] = val + + @property + def font(self): + """ + Sets the title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def pad(self): + """ + Sets the padding of the title. Each padding value only applies + when the corresponding `xanchor`/`yanchor` value is set + accordingly. E.g. for left padding to take effect, `xanchor` + must be set to "left". The same rule applies if + `xanchor`/`yanchor` is determined automatically. Padding is + muted if the respective anchor value is "middle*/*center". + + The 'pad' property is an instance of Pad + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.title.Pad` + - A dict of string/value properties that will be passed + to the Pad constructor + + Returns + ------- + plotly.graph_objs.layout.title.Pad + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def subtitle(self): + """ + The 'subtitle' property is an instance of Subtitle + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.title.Subtitle` + - A dict of string/value properties that will be passed + to the Subtitle constructor + + Returns + ------- + plotly.graph_objs.layout.title.Subtitle + """ + return self["subtitle"] + + @subtitle.setter + def subtitle(self, val): + self["subtitle"] = val + + @property + def text(self): + """ + Sets the plot's title. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` in normalized + coordinates from 0 (left) to 1 (right). + + The 'x' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the title's horizontal alignment with respect to its x + position. "left" means that the title starts at x, "right" + means that the title ends at x and "center" means that the + title's center is at x. "auto" divides `xref` by three and + calculates the `xanchor` value automatically based on the value + of `x`. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` in normalized + coordinates from 0 (bottom) to 1 (top). "auto" places the + baseline of the title onto the vertical center of the top + margin. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the title's vertical alignment with respect to its y + position. "top" means that the title's cap line is at y, + "bottom" means that the title's baseline is at y and "middle" + means that the title's midline is at y. "auto" divides `yref` + by three and calculates the `yanchor` value automatically based + on the value of `y`. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + automargin + Determines whether the title can automatically push the + figure margins. If `yref='paper'` then the margin will + expand to ensure that the title doesn’t overlap with + the edges of the container. If `yref='container'` then + the margins will ensure that the title doesn’t overlap + with the plot area, tick labels, and axis titles. If + `automargin=true` and the margins need to be expanded, + then y will be set to a default 1 and yanchor will be + set to an appropriate default to ensure that minimal + margin space is needed. Note that when `yref='paper'`, + only 1 or 0 are allowed y values. Invalid values will + be reset to the default 1. + font + Sets the title font. + pad + Sets the padding of the title. Each padding value only + applies when the corresponding `xanchor`/`yanchor` + value is set accordingly. E.g. for left padding to take + effect, `xanchor` must be set to "left". The same rule + applies if `xanchor`/`yanchor` is determined + automatically. Padding is muted if the respective + anchor value is "middle*/*center". + subtitle + :class:`plotly.graph_objects.layout.title.Subtitle` + instance or dict with compatible properties + text + Sets the plot's title. + x + Sets the x position with respect to `xref` in + normalized coordinates from 0 (left) to 1 (right). + xanchor + Sets the title's horizontal alignment with respect to + its x position. "left" means that the title starts at + x, "right" means that the title ends at x and "center" + means that the title's center is at x. "auto" divides + `xref` by three and calculates the `xanchor` value + automatically based on the value of `x`. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` in + normalized coordinates from 0 (bottom) to 1 (top). + "auto" places the baseline of the title onto the + vertical center of the top margin. + yanchor + Sets the title's vertical alignment with respect to its + y position. "top" means that the title's cap line is at + y, "bottom" means that the title's baseline is at y and + "middle" means that the title's midline is at y. "auto" + divides `yref` by three and calculates the `yanchor` + value automatically based on the value of `y`. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + automargin=None, + font=None, + pad=None, + subtitle=None, + text=None, + x=None, + xanchor=None, + xref=None, + y=None, + yanchor=None, + yref=None, + **kwargs, + ): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.Title` + automargin + Determines whether the title can automatically push the + figure margins. If `yref='paper'` then the margin will + expand to ensure that the title doesn’t overlap with + the edges of the container. If `yref='container'` then + the margins will ensure that the title doesn’t overlap + with the plot area, tick labels, and axis titles. If + `automargin=true` and the margins need to be expanded, + then y will be set to a default 1 and yanchor will be + set to an appropriate default to ensure that minimal + margin space is needed. Note that when `yref='paper'`, + only 1 or 0 are allowed y values. Invalid values will + be reset to the default 1. + font + Sets the title font. + pad + Sets the padding of the title. Each padding value only + applies when the corresponding `xanchor`/`yanchor` + value is set accordingly. E.g. for left padding to take + effect, `xanchor` must be set to "left". The same rule + applies if `xanchor`/`yanchor` is determined + automatically. Padding is muted if the respective + anchor value is "middle*/*center". + subtitle + :class:`plotly.graph_objects.layout.title.Subtitle` + instance or dict with compatible properties + text + Sets the plot's title. + x + Sets the x position with respect to `xref` in + normalized coordinates from 0 (left) to 1 (right). + xanchor + Sets the title's horizontal alignment with respect to + its x position. "left" means that the title starts at + x, "right" means that the title ends at x and "center" + means that the title's center is at x. "auto" divides + `xref` by three and calculates the `xanchor` value + automatically based on the value of `x`. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` in + normalized coordinates from 0 (bottom) to 1 (top). + "auto" places the baseline of the title onto the + vertical center of the top margin. + yanchor + Sets the title's vertical alignment with respect to its + y position. "top" means that the title's cap line is at + y, "bottom" means that the title's baseline is at y and + "middle" means that the title's midline is at y. "auto" + divides `yref` by three and calculates the `yanchor` + value automatically based on the value of `y`. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("automargin", arg, automargin) + self._set_property("font", arg, font) + self._set_property("pad", arg, pad) + self._set_property("subtitle", arg, subtitle) + self._set_property("text", arg, text) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_transition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_transition.py new file mode 100644 index 0000000..fec6a28 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_transition.py @@ -0,0 +1,144 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Transition(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.transition" + _valid_props = {"duration", "easing", "ordering"} + + @property + def duration(self): + """ + The duration of the transition, in milliseconds. If equal to + zero, updates are synchronous. + + The 'duration' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["duration"] + + @duration.setter + def duration(self, val): + self["duration"] = val + + @property + def easing(self): + """ + The easing function used for the transition + + The 'easing' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'quad', 'cubic', 'sin', 'exp', 'circle', + 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', + 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', + 'back-in', 'bounce-in', 'linear-out', 'quad-out', + 'cubic-out', 'sin-out', 'exp-out', 'circle-out', + 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', + 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', + 'circle-in-out', 'elastic-in-out', 'back-in-out', + 'bounce-in-out'] + + Returns + ------- + Any + """ + return self["easing"] + + @easing.setter + def easing(self, val): + self["easing"] = val + + @property + def ordering(self): + """ + Determines whether the figure's layout or traces smoothly + transitions during updates that make both traces and layout + change. + + The 'ordering' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['layout first', 'traces first'] + + Returns + ------- + Any + """ + return self["ordering"] + + @ordering.setter + def ordering(self, val): + self["ordering"] = val + + @property + def _prop_descriptions(self): + return """\ + duration + The duration of the transition, in milliseconds. If + equal to zero, updates are synchronous. + easing + The easing function used for the transition + ordering + Determines whether the figure's layout or traces + smoothly transitions during updates that make both + traces and layout change. + """ + + def __init__(self, arg=None, duration=None, easing=None, ordering=None, **kwargs): + """ + Construct a new Transition object + + Sets transition options used during Plotly.react updates. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Transition` + duration + The duration of the transition, in milliseconds. If + equal to zero, updates are synchronous. + easing + The easing function used for the transition + ordering + Determines whether the figure's layout or traces + smoothly transitions during updates that make both + traces and layout change. + + Returns + ------- + Transition + """ + super().__init__("transition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Transition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Transition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("duration", arg, duration) + self._set_property("easing", arg, easing) + self._set_property("ordering", arg, ordering) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_uniformtext.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_uniformtext.py new file mode 100644 index 0000000..a47da28 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_uniformtext.py @@ -0,0 +1,124 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Uniformtext(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.uniformtext" + _valid_props = {"minsize", "mode"} + + @property + def minsize(self): + """ + Sets the minimum text size between traces of the same type. + + The 'minsize' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minsize"] + + @minsize.setter + def minsize(self, val): + self["minsize"] = val + + @property + def mode(self): + """ + Determines how the font size for various text elements are + uniformed between each trace type. If the computed text sizes + were smaller than the minimum size defined by + `uniformtext.minsize` using "hide" option hides the text; and + using "show" option shows the text without further downscaling. + Please note that if the size defined by `minsize` is greater + than the font size defined by trace, then the `minsize` is + used. + + The 'mode' property is an enumeration that may be specified as: + - One of the following enumeration values: + [False, 'hide', 'show'] + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def _prop_descriptions(self): + return """\ + minsize + Sets the minimum text size between traces of the same + type. + mode + Determines how the font size for various text elements + are uniformed between each trace type. If the computed + text sizes were smaller than the minimum size defined + by `uniformtext.minsize` using "hide" option hides the + text; and using "show" option shows the text without + further downscaling. Please note that if the size + defined by `minsize` is greater than the font size + defined by trace, then the `minsize` is used. + """ + + def __init__(self, arg=None, minsize=None, mode=None, **kwargs): + """ + Construct a new Uniformtext object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Uniformtext` + minsize + Sets the minimum text size between traces of the same + type. + mode + Determines how the font size for various text elements + are uniformed between each trace type. If the computed + text sizes were smaller than the minimum size defined + by `uniformtext.minsize` using "hide" option hides the + text; and using "show" option shows the text without + further downscaling. Please note that if the size + defined by `minsize` is greater than the font size + defined by trace, then the `minsize` is used. + + Returns + ------- + Uniformtext + """ + super().__init__("uniformtext") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Uniformtext +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Uniformtext`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("minsize", arg, minsize) + self._set_property("mode", arg, mode) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_updatemenu.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_updatemenu.py new file mode 100644 index 0000000..ebd1e67 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_updatemenu.py @@ -0,0 +1,632 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Updatemenu(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.updatemenu" + _valid_props = { + "active", + "bgcolor", + "bordercolor", + "borderwidth", + "buttondefaults", + "buttons", + "direction", + "font", + "name", + "pad", + "showactive", + "templateitemname", + "type", + "visible", + "x", + "xanchor", + "y", + "yanchor", + } + + @property + def active(self): + """ + Determines which button (by index starting from 0) is + considered active. + + The 'active' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + + Returns + ------- + int + """ + return self["active"] + + @active.setter + def active(self, val): + self["active"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the update menu buttons. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the update menu. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the update menu. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def buttons(self): + """ + The 'buttons' property is a tuple of instances of + Button that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.updatemenu.Button + - A list or tuple of dicts of string/value properties that + will be passed to the Button constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.updatemenu.Button] + """ + return self["buttons"] + + @buttons.setter + def buttons(self, val): + self["buttons"] = val + + @property + def buttondefaults(self): + """ + When used in a template (as + layout.template.layout.updatemenu.buttondefaults), sets the + default property values to use for elements of + layout.updatemenu.buttons + + The 'buttondefaults' property is an instance of Button + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.updatemenu.Button` + - A dict of string/value properties that will be passed + to the Button constructor + + Returns + ------- + plotly.graph_objs.layout.updatemenu.Button + """ + return self["buttondefaults"] + + @buttondefaults.setter + def buttondefaults(self, val): + self["buttondefaults"] = val + + @property + def direction(self): + """ + Determines the direction in which the buttons are laid out, + whether in a dropdown menu or a row/column of buttons. For + `left` and `up`, the buttons will still appear in left-to-right + or top-to-bottom order respectively. + + The 'direction' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'up', 'down'] + + Returns + ------- + Any + """ + return self["direction"] + + @direction.setter + def direction(self, val): + self["direction"] = val + + @property + def font(self): + """ + Sets the font of the update menu button text. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.updatemenu.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.updatemenu.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def pad(self): + """ + Sets the padding around the buttons or dropdown menu. + + The 'pad' property is an instance of Pad + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.updatemenu.Pad` + - A dict of string/value properties that will be passed + to the Pad constructor + + Returns + ------- + plotly.graph_objs.layout.updatemenu.Pad + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def showactive(self): + """ + Highlights active dropdown item or active button if true. + + The 'showactive' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showactive"] + + @showactive.setter + def showactive(self, val): + self["showactive"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def type(self): + """ + Determines whether the buttons are accessible via a dropdown + menu or whether the buttons are stacked horizontally or + vertically + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['dropdown', 'buttons'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + Determines whether or not the update menu is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x position (in normalized coordinates) of the update + menu. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the update menu's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the range selector. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def y(self): + """ + Sets the y position (in normalized coordinates) of the update + menu. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the update menu's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the range selector. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def _prop_descriptions(self): + return """\ + active + Determines which button (by index starting from 0) is + considered active. + bgcolor + Sets the background color of the update menu buttons. + bordercolor + Sets the color of the border enclosing the update menu. + borderwidth + Sets the width (in px) of the border enclosing the + update menu. + buttons + A tuple of + :class:`plotly.graph_objects.layout.updatemenu.Button` + instances or dicts with compatible properties + buttondefaults + When used in a template (as + layout.template.layout.updatemenu.buttondefaults), sets + the default property values to use for elements of + layout.updatemenu.buttons + direction + Determines the direction in which the buttons are laid + out, whether in a dropdown menu or a row/column of + buttons. For `left` and `up`, the buttons will still + appear in left-to-right or top-to-bottom order + respectively. + font + Sets the font of the update menu button text. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Sets the padding around the buttons or dropdown menu. + showactive + Highlights active dropdown item or active button if + true. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Determines whether the buttons are accessible via a + dropdown menu or whether the buttons are stacked + horizontally or vertically + visible + Determines whether or not the update menu is visible. + x + Sets the x position (in normalized coordinates) of the + update menu. + xanchor + Sets the update menu's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + update menu. + yanchor + Sets the update menu's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + """ + + def __init__( + self, + arg=None, + active=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + buttons=None, + buttondefaults=None, + direction=None, + font=None, + name=None, + pad=None, + showactive=None, + templateitemname=None, + type=None, + visible=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs, + ): + """ + Construct a new Updatemenu object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.Updatemenu` + active + Determines which button (by index starting from 0) is + considered active. + bgcolor + Sets the background color of the update menu buttons. + bordercolor + Sets the color of the border enclosing the update menu. + borderwidth + Sets the width (in px) of the border enclosing the + update menu. + buttons + A tuple of + :class:`plotly.graph_objects.layout.updatemenu.Button` + instances or dicts with compatible properties + buttondefaults + When used in a template (as + layout.template.layout.updatemenu.buttondefaults), sets + the default property values to use for elements of + layout.updatemenu.buttons + direction + Determines the direction in which the buttons are laid + out, whether in a dropdown menu or a row/column of + buttons. For `left` and `up`, the buttons will still + appear in left-to-right or top-to-bottom order + respectively. + font + Sets the font of the update menu button text. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pad + Sets the padding around the buttons or dropdown menu. + showactive + Highlights active dropdown item or active button if + true. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Determines whether the buttons are accessible via a + dropdown menu or whether the buttons are stacked + horizontally or vertically + visible + Determines whether or not the update menu is visible. + x + Sets the x position (in normalized coordinates) of the + update menu. + xanchor + Sets the update menu's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + update menu. + yanchor + Sets the update menu's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + + Returns + ------- + Updatemenu + """ + super().__init__("updatemenus") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.Updatemenu +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.Updatemenu`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("active", arg, active) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("buttons", arg, buttons) + self._set_property("buttondefaults", arg, buttondefaults) + self._set_property("direction", arg, direction) + self._set_property("font", arg, font) + self._set_property("name", arg, name) + self._set_property("pad", arg, pad) + self._set_property("showactive", arg, showactive) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_xaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_xaxis.py new file mode 100644 index 0000000..901e418 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_xaxis.py @@ -0,0 +1,3415 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class XAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.xaxis" + _valid_props = { + "anchor", + "automargin", + "autorange", + "autorangeoptions", + "autotickangles", + "autotypenumbers", + "calendar", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "constrain", + "constraintoward", + "dividercolor", + "dividerwidth", + "domain", + "dtick", + "exponentformat", + "fixedrange", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "insiderange", + "labelalias", + "layer", + "linecolor", + "linewidth", + "matches", + "maxallowed", + "minallowed", + "minexponent", + "minor", + "mirror", + "nticks", + "overlaying", + "position", + "range", + "rangebreakdefaults", + "rangebreaks", + "rangemode", + "rangeselector", + "rangeslider", + "scaleanchor", + "scaleratio", + "separatethousands", + "showdividers", + "showexponent", + "showgrid", + "showline", + "showspikes", + "showticklabels", + "showtickprefix", + "showticksuffix", + "side", + "spikecolor", + "spikedash", + "spikemode", + "spikesnap", + "spikethickness", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelindex", + "ticklabelindexsrc", + "ticklabelmode", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelshift", + "ticklabelstandoff", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "tickson", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "type", + "uirevision", + "visible", + "zeroline", + "zerolinecolor", + "zerolinewidth", + } + + @property + def anchor(self): + """ + If set to an opposite-letter axis id (e.g. `x2`, `y`), this + axis is bound to the corresponding opposite-letter axis. If set + to "free", this axis' position is determined by `position`. + + The 'anchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['free'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["anchor"] + + @anchor.setter + def anchor(self, val): + self["anchor"] = val + + @property + def automargin(self): + """ + Determines whether long tick labels automatically grow the + figure margins. + + The 'automargin' property is a flaglist and may be specified + as a string containing: + - Any combination of ['height', 'width', 'left', 'right', 'top', 'bottom'] joined with '+' characters + (e.g. 'height+width') + OR exactly one of [True, False] (e.g. 'False') + + Returns + ------- + Any + """ + return self["automargin"] + + @automargin.setter + def automargin(self, val): + self["automargin"] = val + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided and it has a value for both the lower and + upper bound, `autorange` is set to False. Using "min" applies + autorange only to set the minimum. Using "max" applies + autorange only to set the maximum. Using *min reversed* applies + autorange only to set the minimum on a reversed axis. Using + *max reversed* applies autorange only to set the maximum on a + reversed axis. Using "reversed" applies autorange on both ends + and reverses the axis direction. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autorangeoptions(self): + """ + The 'autorangeoptions' property is an instance of Autorangeoptions + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Autorangeoptions` + - A dict of string/value properties that will be passed + to the Autorangeoptions constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Autorangeoptions + """ + return self["autorangeoptions"] + + @autorangeoptions.setter + def autorangeoptions(self, val): + self["autorangeoptions"] = val + + @property + def autotickangles(self): + """ + When `tickangle` is set to "auto", it will be set to the first + angle in this array that is large enough to prevent label + overlap. + + The 'autotickangles' property is an info array that may be specified as: + * a list of elements where: + The 'autotickangles[i]' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + list + """ + return self["autotickangles"] + + @autotickangles.setter + def autotickangles(self, val): + self["autotickangles"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def constrain(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines how that happens: by increasing the "range", or by + decreasing the "domain". Default is "domain" for axes + containing image traces, "range" otherwise. + + The 'constrain' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['range', 'domain'] + + Returns + ------- + Any + """ + return self["constrain"] + + @constrain.setter + def constrain(self, val): + self["constrain"] = val + + @property + def constraintoward(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines which direction we push the originally specified + plot area. Options are "left", "center" (default), and "right" + for x axes, and "top", "middle" (default), and "bottom" for y + axes. + + The 'constraintoward' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["constraintoward"] + + @constraintoward.setter + def constraintoward(self, val): + self["constraintoward"] = val + + @property + def dividercolor(self): + """ + Sets the color of the dividers Only has an effect on + "multicategory" axes. + + The 'dividercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["dividercolor"] + + @dividercolor.setter + def dividercolor(self, val): + self["dividercolor"] = val + + @property + def dividerwidth(self): + """ + Sets the width (in px) of the dividers Only has an effect on + "multicategory" axes. + + The 'dividerwidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dividerwidth"] + + @dividerwidth.setter + def dividerwidth(self, val): + self["dividerwidth"] = val + + @property + def domain(self): + """ + Sets the domain of this axis (in plot fraction). + + The 'domain' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'domain[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'domain[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def fixedrange(self): + """ + Determines whether or not this axis is zoom-able. If true, then + zoom is disabled. + + The 'fixedrange' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["fixedrange"] + + @fixedrange.setter + def fixedrange(self, val): + self["fixedrange"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def insiderange(self): + """ + Could be used to set the desired inside range of this axis + (excluding the labels) when `ticklabelposition` of the anchored + axis has "inside". Not implemented for axes with `type` "log". + This would be ignored when `range` is provided. + + The 'insiderange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'insiderange[0]' property accepts values of any type + (1) The 'insiderange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["insiderange"] + + @insiderange.setter + def insiderange(self, val): + self["insiderange"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def matches(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis will match the range of the corresponding axis in data- + coordinates space. Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. Note that + setting axes simultaneously in both a `scaleanchor` and a + `matches` constraint is currently forbidden. Moreover, note + that matching axes must have the same `type`. + + The 'matches' property is an enumeration that may be specified as: + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["matches"] + + @matches.setter + def matches(self, val): + self["matches"] = val + + @property + def maxallowed(self): + """ + Determines the maximum range of this axis. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Determines the minimum range of this axis. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def minor(self): + """ + The 'minor' property is an instance of Minor + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Minor` + - A dict of string/value properties that will be passed + to the Minor constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Minor + """ + return self["minor"] + + @minor.setter + def minor(self, val): + self["minor"] = val + + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self["mirror"] + + @mirror.setter + def mirror(self, val): + self["mirror"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def overlaying(self): + """ + If set a same-letter axis id, this axis is overlaid on top of + the corresponding same-letter axis, with traces and axes + visible for both axes. If False, this axis does not overlay any + same-letter axes. In this case, for axes with overlapping + domains only the highest-numbered axis will be visible. + + The 'overlaying' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['free'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["overlaying"] + + @overlaying.setter + def overlaying(self, val): + self["overlaying"] = val + + @property + def position(self): + """ + Sets the position of this axis in the plotting space (in + normalized coordinates). Only has an effect if `anchor` is set + to "free". + + The 'position' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["position"] + + @position.setter + def position(self, val): + self["position"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + Leaving either or both elements `null` impacts the default + `autorange`. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangebreaks(self): + """ + The 'rangebreaks' property is a tuple of instances of + Rangebreak that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.xaxis.Rangebreak + - A list or tuple of dicts of string/value properties that + will be passed to the Rangebreak constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.xaxis.Rangebreak] + """ + return self["rangebreaks"] + + @rangebreaks.setter + def rangebreaks(self, val): + self["rangebreaks"] = val + + @property + def rangebreakdefaults(self): + """ + When used in a template (as + layout.template.layout.xaxis.rangebreakdefaults), sets the + default property values to use for elements of + layout.xaxis.rangebreaks + + The 'rangebreakdefaults' property is an instance of Rangebreak + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Rangebreak` + - A dict of string/value properties that will be passed + to the Rangebreak constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Rangebreak + """ + return self["rangebreakdefaults"] + + @rangebreakdefaults.setter + def rangebreakdefaults(self, val): + self["rangebreakdefaults"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def rangeselector(self): + """ + The 'rangeselector' property is an instance of Rangeselector + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Rangeselector` + - A dict of string/value properties that will be passed + to the Rangeselector constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Rangeselector + """ + return self["rangeselector"] + + @rangeselector.setter + def rangeselector(self, val): + self["rangeselector"] = val + + @property + def rangeslider(self): + """ + The 'rangeslider' property is an instance of Rangeslider + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Rangeslider` + - A dict of string/value properties that will be passed + to the Rangeslider constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Rangeslider + """ + return self["rangeslider"] + + @rangeslider.setter + def rangeslider(self, val): + self["rangeslider"] = val + + @property + def scaleanchor(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis changes together with the range of the corresponding axis + such that the scale of pixels per unit is in a constant ratio. + Both axes are still zoomable, but when you zoom one, the other + will zoom the same amount, keeping a fixed midpoint. + `constrain` and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, + xaxis2: {scaleanchor: *y*}` but you can only link axes of the + same `type`. The linked axis can have the opposite letter (to + constrain the aspect ratio) or the same letter (to match scales + across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the last + constraint encountered will be ignored to avoid possible + inconsistent constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and a `matches` + constraint is currently forbidden. Setting `false` allows to + remove a default constraint (occasionally, you may need to + prevent a default `scaleanchor` constraint from being applied, + eg. when having an image trace `yaxis: {scaleanchor: "x"}` is + set automatically in order for pixels to be rendered as + squares, setting `yaxis: {scaleanchor: false}` allows to remove + the constraint). + + The 'scaleanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + [False] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["scaleanchor"] + + @scaleanchor.setter + def scaleanchor(self, val): + self["scaleanchor"] = val + + @property + def scaleratio(self): + """ + If this axis is linked to another by `scaleanchor`, this + determines the pixel to unit scale ratio. For example, if this + value is 10, then every unit on this axis spans 10 times the + number of pixels as a unit on the linked axis. Use this for + example to create an elevation profile where the vertical scale + is exaggerated a fixed amount with respect to the horizontal. + + The 'scaleratio' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["scaleratio"] + + @scaleratio.setter + def scaleratio(self, val): + self["scaleratio"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showdividers(self): + """ + Determines whether or not a dividers are drawn between the + category levels of this axis. Only has an effect on + "multicategory" axes. + + The 'showdividers' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showdividers"] + + @showdividers.setter + def showdividers(self, val): + self["showdividers"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showspikes(self): + """ + Determines whether or not spikes (aka droplines) are drawn for + this axis. Note: This only takes affect when hovermode = + closest + + The 'showspikes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showspikes"] + + @showspikes.setter + def showspikes(self, val): + self["showspikes"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def side(self): + """ + Determines whether a x (y) axis is positioned at the "bottom" + ("left") or "top" ("right") of the plotting area. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom', 'left', 'right'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def spikecolor(self): + """ + Sets the spike color. If undefined, will use the series color + + The 'spikecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["spikecolor"] + + @spikecolor.setter + def spikecolor(self, val): + self["spikecolor"] = val + + @property + def spikedash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'spikedash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["spikedash"] + + @spikedash.setter + def spikedash(self, val): + self["spikedash"] = val + + @property + def spikemode(self): + """ + Determines the drawing mode for the spike line If "toaxis", the + line is drawn from the data point to the axis the series is + plotted on. If "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If "marker", then a marker + dot is drawn on the axis the series is plotted on + + The 'spikemode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters + (e.g. 'toaxis+across') + + Returns + ------- + Any + """ + return self["spikemode"] + + @spikemode.setter + def spikemode(self, val): + self["spikemode"] = val + + @property + def spikesnap(self): + """ + Determines whether spikelines are stuck to the cursor or to the + closest datapoints. + + The 'spikesnap' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['data', 'cursor', 'hovered data'] + + Returns + ------- + Any + """ + return self["spikesnap"] + + @spikesnap.setter + def spikesnap(self, val): + self["spikesnap"] = val + + @property + def spikethickness(self): + """ + Sets the width (in px) of the zero line. + + The 'spikethickness' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["spikethickness"] + + @spikethickness.setter + def spikethickness(self, val): + self["spikethickness"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.xaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.xaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.xaxis.tickformatstopdefaults), sets the + default property values to use for elements of + layout.xaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelindex(self): + """ + Only for axes with `type` "date" or "linear". Instead of + drawing the major tick label, draw the label for the minor tick + that is n positions away from the major tick. E.g. to always + draw the label for the minor tick before each major tick, + choose `ticklabelindex` -1. This is useful for date axes with + `ticklabelmode` "period" if you want to label the period that + ends with each major tick instead of the period that begins + there. + + The 'ticklabelindex' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["ticklabelindex"] + + @ticklabelindex.setter + def ticklabelindex(self, val): + self["ticklabelindex"] = val + + @property + def ticklabelindexsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `ticklabelindex`. + + The 'ticklabelindexsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticklabelindexsrc"] + + @ticklabelindexsrc.setter + def ticklabelindexsrc(self, val): + self["ticklabelindexsrc"] = val + + @property + def ticklabelmode(self): + """ + Determines where tick labels are drawn with respect to their + corresponding ticks and grid lines. Only has an effect for axes + of `type` "date" When set to "period", tick labels are drawn in + the middle of the period between ticks. + + The 'ticklabelmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['instant', 'period'] + + Returns + ------- + Any + """ + return self["ticklabelmode"] + + @ticklabelmode.setter + def ticklabelmode(self, val): + self["ticklabelmode"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. Otherwise on + "category" and "multicategory" axes the default is "allow". In + other cases the default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn with respect to the axis + Please note that top or bottom has no effect on x axes or when + `ticklabelmode` is set to "period". Similarly left or right has + no effect on y axes or when `ticklabelmode` is set to "period". + Has no effect on "multicategory" axes or when `tickson` is set + to "boundaries". When used on axes linked by `matches` or + `scaleanchor`, no extra padding for inside labels would be + added by autorange, so that the scales could match. + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelshift(self): + """ + Shifts the tick labels by the specified number of pixels in + parallel to the axis. Positive values move the labels in the + positive direction of the axis. + + The 'ticklabelshift' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["ticklabelshift"] + + @ticklabelshift.setter + def ticklabelshift(self, val): + self["ticklabelshift"] = val + + @property + def ticklabelstandoff(self): + """ + Sets the standoff distance (in px) between the axis tick labels + and their default position. A positive `ticklabelstandoff` + moves the labels farther away from the plot area if + `ticklabelposition` is "outside", and deeper into the plot area + if `ticklabelposition` is "inside". A negative + `ticklabelstandoff` works in the opposite direction, moving + outside ticks towards the plot area and inside ticks towards + the outside. If the negative value is large enough, inside + ticks can even end up outside and vice versa. + + The 'ticklabelstandoff' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["ticklabelstandoff"] + + @ticklabelstandoff.setter + def ticklabelstandoff(self, val): + self["ticklabelstandoff"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). If "sync", the + number of ticks will sync with the overlayed axis set by + `overlaying` property. + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array', 'sync'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def tickson(self): + """ + Determines where ticks and grid lines are drawn with respect to + their corresponding tick labels. Only has an effect for axes of + `type` "category" or "multicategory". When set to "boundaries", + ticks and grid lines are drawn half a category to the + left/bottom of labels. + + The 'tickson' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['labels', 'boundaries'] + + Returns + ------- + Any + """ + return self["tickson"] + + @tickson.setter + def tickson(self, val): + self["tickson"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'log', 'date', 'category', + 'multicategory'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `range`, + `autorange`, and `title` if in `editable: true` configuration. + Defaults to `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def zeroline(self): + """ + Determines whether or not a line is drawn at along the 0 value + of this axis. If True, the zero line is drawn on top of the + grid lines. + + The 'zeroline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zeroline"] + + @zeroline.setter + def zeroline(self, val): + self["zeroline"] = val + + @property + def zerolinecolor(self): + """ + Sets the line color of the zero line. + + The 'zerolinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["zerolinecolor"] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self["zerolinecolor"] = val + + @property + def zerolinewidth(self): + """ + Sets the width (in px) of the zero line. + + The 'zerolinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zerolinewidth"] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self["zerolinewidth"] = val + + @property + def _prop_descriptions(self): + return """\ + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.xaxis.Autorangeopti + ons` instance or dict with compatible properties + autotickangles + When `tickangle` is set to "auto", it will be set to + the first angle in this array that is large enough to + prevent label overlap. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range", or by decreasing the "domain". Default is + "domain" for axes containing image traces, "range" + otherwise. + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + insiderange + Could be used to set the desired inside range of this + axis (excluding the labels) when `ticklabelposition` of + the anchored axis has "inside". Not implemented for + axes with `type` "log". This would be ignored when + `range` is provided. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + minor + :class:`plotly.graph_objects.layout.xaxis.Minor` + instance or dict with compatible properties + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangebreaks + A tuple of + :class:`plotly.graph_objects.layout.xaxis.Rangebreak` + instances or dicts with compatible properties + rangebreakdefaults + When used in a template (as + layout.template.layout.xaxis.rangebreakdefaults), sets + the default property values to use for elements of + layout.xaxis.rangebreaks + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + rangeselector + :class:`plotly.graph_objects.layout.xaxis.Rangeselector + ` instance or dict with compatible properties + rangeslider + :class:`plotly.graph_objects.layout.xaxis.Rangeslider` + instance or dict with compatible properties + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. Setting `false` allows to remove a default + constraint (occasionally, you may need to prevent a + default `scaleanchor` constraint from being applied, + eg. when having an image trace `yaxis: {scaleanchor: + "x"}` is set automatically in order for pixels to be + rendered as squares, setting `yaxis: {scaleanchor: + false}` allows to remove the constraint). + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.xaxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.xaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.xaxis.tickformatstops + ticklabelindex + Only for axes with `type` "date" or "linear". Instead + of drawing the major tick label, draw the label for the + minor tick that is n positions away from the major + tick. E.g. to always draw the label for the minor tick + before each major tick, choose `ticklabelindex` -1. + This is useful for date axes with `ticklabelmode` + "period" if you want to label the period that ends with + each major tick instead of the period that begins + there. + ticklabelindexsrc + Sets the source reference on Chart Studio Cloud for + `ticklabelindex`. + ticklabelmode + Determines where tick labels are drawn with respect to + their corresponding ticks and grid lines. Only has an + effect for axes of `type` "date" When set to "period", + tick labels are drawn in the middle of the period + between ticks. + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. Otherwise on "category" and + "multicategory" axes the default is "allow". In other + cases the default is *hide past div*. + ticklabelposition + Determines where tick labels are drawn with respect to + the axis Please note that top or bottom has no effect + on x axes or when `ticklabelmode` is set to "period". + Similarly left or right has no effect on y axes or when + `ticklabelmode` is set to "period". Has no effect on + "multicategory" axes or when `tickson` is set to + "boundaries". When used on axes linked by `matches` or + `scaleanchor`, no extra padding for inside labels would + be added by autorange, so that the scales could match. + ticklabelshift + Shifts the tick labels by the specified number of + pixels in parallel to the axis. Positive values move + the labels in the positive direction of the axis. + ticklabelstandoff + Sets the standoff distance (in px) between the axis + tick labels and their default position. A positive + `ticklabelstandoff` moves the labels farther away from + the plot area if `ticklabelposition` is "outside", and + deeper into the plot area if `ticklabelposition` is + "inside". A negative `ticklabelstandoff` works in the + opposite direction, moving outside ticks towards the + plot area and inside ticks towards the outside. If the + negative value is large enough, inside ticks can even + end up outside and vice versa. + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). If + "sync", the number of ticks will sync with the + overlayed axis set by `overlaying` property. + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.xaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + def __init__( + self, + arg=None, + anchor=None, + automargin=None, + autorange=None, + autorangeoptions=None, + autotickangles=None, + autotypenumbers=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + constrain=None, + constraintoward=None, + dividercolor=None, + dividerwidth=None, + domain=None, + dtick=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + insiderange=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + matches=None, + maxallowed=None, + minallowed=None, + minexponent=None, + minor=None, + mirror=None, + nticks=None, + overlaying=None, + position=None, + range=None, + rangebreaks=None, + rangebreakdefaults=None, + rangemode=None, + rangeselector=None, + rangeslider=None, + scaleanchor=None, + scaleratio=None, + separatethousands=None, + showdividers=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + spikecolor=None, + spikedash=None, + spikemode=None, + spikesnap=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelindex=None, + ticklabelindexsrc=None, + ticklabelmode=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelshift=None, + ticklabelstandoff=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + tickson=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + type=None, + uirevision=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs, + ): + """ + Construct a new XAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.XAxis` + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.xaxis.Autorangeopti + ons` instance or dict with compatible properties + autotickangles + When `tickangle` is set to "auto", it will be set to + the first angle in this array that is large enough to + prevent label overlap. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range", or by decreasing the "domain". Default is + "domain" for axes containing image traces, "range" + otherwise. + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + insiderange + Could be used to set the desired inside range of this + axis (excluding the labels) when `ticklabelposition` of + the anchored axis has "inside". Not implemented for + axes with `type` "log". This would be ignored when + `range` is provided. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + minor + :class:`plotly.graph_objects.layout.xaxis.Minor` + instance or dict with compatible properties + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangebreaks + A tuple of + :class:`plotly.graph_objects.layout.xaxis.Rangebreak` + instances or dicts with compatible properties + rangebreakdefaults + When used in a template (as + layout.template.layout.xaxis.rangebreakdefaults), sets + the default property values to use for elements of + layout.xaxis.rangebreaks + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + rangeselector + :class:`plotly.graph_objects.layout.xaxis.Rangeselector + ` instance or dict with compatible properties + rangeslider + :class:`plotly.graph_objects.layout.xaxis.Rangeslider` + instance or dict with compatible properties + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. Setting `false` allows to remove a default + constraint (occasionally, you may need to prevent a + default `scaleanchor` constraint from being applied, + eg. when having an image trace `yaxis: {scaleanchor: + "x"}` is set automatically in order for pixels to be + rendered as squares, setting `yaxis: {scaleanchor: + false}` allows to remove the constraint). + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.xaxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.xaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.xaxis.tickformatstops + ticklabelindex + Only for axes with `type` "date" or "linear". Instead + of drawing the major tick label, draw the label for the + minor tick that is n positions away from the major + tick. E.g. to always draw the label for the minor tick + before each major tick, choose `ticklabelindex` -1. + This is useful for date axes with `ticklabelmode` + "period" if you want to label the period that ends with + each major tick instead of the period that begins + there. + ticklabelindexsrc + Sets the source reference on Chart Studio Cloud for + `ticklabelindex`. + ticklabelmode + Determines where tick labels are drawn with respect to + their corresponding ticks and grid lines. Only has an + effect for axes of `type` "date" When set to "period", + tick labels are drawn in the middle of the period + between ticks. + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. Otherwise on "category" and + "multicategory" axes the default is "allow". In other + cases the default is *hide past div*. + ticklabelposition + Determines where tick labels are drawn with respect to + the axis Please note that top or bottom has no effect + on x axes or when `ticklabelmode` is set to "period". + Similarly left or right has no effect on y axes or when + `ticklabelmode` is set to "period". Has no effect on + "multicategory" axes or when `tickson` is set to + "boundaries". When used on axes linked by `matches` or + `scaleanchor`, no extra padding for inside labels would + be added by autorange, so that the scales could match. + ticklabelshift + Shifts the tick labels by the specified number of + pixels in parallel to the axis. Positive values move + the labels in the positive direction of the axis. + ticklabelstandoff + Sets the standoff distance (in px) between the axis + tick labels and their default position. A positive + `ticklabelstandoff` moves the labels farther away from + the plot area if `ticklabelposition` is "outside", and + deeper into the plot area if `ticklabelposition` is + "inside". A negative `ticklabelstandoff` works in the + opposite direction, moving outside ticks towards the + plot area and inside ticks towards the outside. If the + negative value is large enough, inside ticks can even + end up outside and vice versa. + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). If + "sync", the number of ticks will sync with the + overlayed axis set by `overlaying` property. + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.xaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + XAxis + """ + super().__init__("xaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.XAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.XAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("anchor", arg, anchor) + self._set_property("automargin", arg, automargin) + self._set_property("autorange", arg, autorange) + self._set_property("autorangeoptions", arg, autorangeoptions) + self._set_property("autotickangles", arg, autotickangles) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("calendar", arg, calendar) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("constrain", arg, constrain) + self._set_property("constraintoward", arg, constraintoward) + self._set_property("dividercolor", arg, dividercolor) + self._set_property("dividerwidth", arg, dividerwidth) + self._set_property("domain", arg, domain) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("fixedrange", arg, fixedrange) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("insiderange", arg, insiderange) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("matches", arg, matches) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._set_property("minexponent", arg, minexponent) + self._set_property("minor", arg, minor) + self._set_property("mirror", arg, mirror) + self._set_property("nticks", arg, nticks) + self._set_property("overlaying", arg, overlaying) + self._set_property("position", arg, position) + self._set_property("range", arg, range) + self._set_property("rangebreaks", arg, rangebreaks) + self._set_property("rangebreakdefaults", arg, rangebreakdefaults) + self._set_property("rangemode", arg, rangemode) + self._set_property("rangeselector", arg, rangeselector) + self._set_property("rangeslider", arg, rangeslider) + self._set_property("scaleanchor", arg, scaleanchor) + self._set_property("scaleratio", arg, scaleratio) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showdividers", arg, showdividers) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showspikes", arg, showspikes) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("side", arg, side) + self._set_property("spikecolor", arg, spikecolor) + self._set_property("spikedash", arg, spikedash) + self._set_property("spikemode", arg, spikemode) + self._set_property("spikesnap", arg, spikesnap) + self._set_property("spikethickness", arg, spikethickness) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelindex", arg, ticklabelindex) + self._set_property("ticklabelindexsrc", arg, ticklabelindexsrc) + self._set_property("ticklabelmode", arg, ticklabelmode) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelshift", arg, ticklabelshift) + self._set_property("ticklabelstandoff", arg, ticklabelstandoff) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("tickson", arg, tickson) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("zeroline", arg, zeroline) + self._set_property("zerolinecolor", arg, zerolinecolor) + self._set_property("zerolinewidth", arg, zerolinewidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_yaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_yaxis.py new file mode 100644 index 0000000..95cf85f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/_yaxis.py @@ -0,0 +1,3443 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class YAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout" + _path_str = "layout.yaxis" + _valid_props = { + "anchor", + "automargin", + "autorange", + "autorangeoptions", + "autoshift", + "autotickangles", + "autotypenumbers", + "calendar", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "constrain", + "constraintoward", + "dividercolor", + "dividerwidth", + "domain", + "dtick", + "exponentformat", + "fixedrange", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "insiderange", + "labelalias", + "layer", + "linecolor", + "linewidth", + "matches", + "maxallowed", + "minallowed", + "minexponent", + "minor", + "mirror", + "nticks", + "overlaying", + "position", + "range", + "rangebreakdefaults", + "rangebreaks", + "rangemode", + "scaleanchor", + "scaleratio", + "separatethousands", + "shift", + "showdividers", + "showexponent", + "showgrid", + "showline", + "showspikes", + "showticklabels", + "showtickprefix", + "showticksuffix", + "side", + "spikecolor", + "spikedash", + "spikemode", + "spikesnap", + "spikethickness", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelindex", + "ticklabelindexsrc", + "ticklabelmode", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelshift", + "ticklabelstandoff", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "tickson", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "type", + "uirevision", + "visible", + "zeroline", + "zerolinecolor", + "zerolinewidth", + } + + @property + def anchor(self): + """ + If set to an opposite-letter axis id (e.g. `x2`, `y`), this + axis is bound to the corresponding opposite-letter axis. If set + to "free", this axis' position is determined by `position`. + + The 'anchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['free'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["anchor"] + + @anchor.setter + def anchor(self, val): + self["anchor"] = val + + @property + def automargin(self): + """ + Determines whether long tick labels automatically grow the + figure margins. + + The 'automargin' property is a flaglist and may be specified + as a string containing: + - Any combination of ['height', 'width', 'left', 'right', 'top', 'bottom'] joined with '+' characters + (e.g. 'height+width') + OR exactly one of [True, False] (e.g. 'False') + + Returns + ------- + Any + """ + return self["automargin"] + + @automargin.setter + def automargin(self, val): + self["automargin"] = val + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided and it has a value for both the lower and + upper bound, `autorange` is set to False. Using "min" applies + autorange only to set the minimum. Using "max" applies + autorange only to set the maximum. Using *min reversed* applies + autorange only to set the minimum on a reversed axis. Using + *max reversed* applies autorange only to set the maximum on a + reversed axis. Using "reversed" applies autorange on both ends + and reverses the axis direction. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autorangeoptions(self): + """ + The 'autorangeoptions' property is an instance of Autorangeoptions + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.Autorangeoptions` + - A dict of string/value properties that will be passed + to the Autorangeoptions constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.Autorangeoptions + """ + return self["autorangeoptions"] + + @autorangeoptions.setter + def autorangeoptions(self, val): + self["autorangeoptions"] = val + + @property + def autoshift(self): + """ + Automatically reposition the axis to avoid overlap with other + axes with the same `overlaying` value. This repositioning will + account for any `shift` amount applied to other axes on the + same side with `autoshift` is set to true. Only has an effect + if `anchor` is set to "free". + + The 'autoshift' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autoshift"] + + @autoshift.setter + def autoshift(self, val): + self["autoshift"] = val + + @property + def autotickangles(self): + """ + When `tickangle` is set to "auto", it will be set to the first + angle in this array that is large enough to prevent label + overlap. + + The 'autotickangles' property is an info array that may be specified as: + * a list of elements where: + The 'autotickangles[i]' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + list + """ + return self["autotickangles"] + + @autotickangles.setter + def autotickangles(self, val): + self["autotickangles"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def constrain(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines how that happens: by increasing the "range", or by + decreasing the "domain". Default is "domain" for axes + containing image traces, "range" otherwise. + + The 'constrain' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['range', 'domain'] + + Returns + ------- + Any + """ + return self["constrain"] + + @constrain.setter + def constrain(self, val): + self["constrain"] = val + + @property + def constraintoward(self): + """ + If this axis needs to be compressed (either due to its own + `scaleanchor` and `scaleratio` or those of the other axis), + determines which direction we push the originally specified + plot area. Options are "left", "center" (default), and "right" + for x axes, and "top", "middle" (default), and "bottom" for y + axes. + + The 'constraintoward' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["constraintoward"] + + @constraintoward.setter + def constraintoward(self, val): + self["constraintoward"] = val + + @property + def dividercolor(self): + """ + Sets the color of the dividers Only has an effect on + "multicategory" axes. + + The 'dividercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["dividercolor"] + + @dividercolor.setter + def dividercolor(self, val): + self["dividercolor"] = val + + @property + def dividerwidth(self): + """ + Sets the width (in px) of the dividers Only has an effect on + "multicategory" axes. + + The 'dividerwidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dividerwidth"] + + @dividerwidth.setter + def dividerwidth(self, val): + self["dividerwidth"] = val + + @property + def domain(self): + """ + Sets the domain of this axis (in plot fraction). + + The 'domain' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'domain[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'domain[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["domain"] + + @domain.setter + def domain(self, val): + self["domain"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def fixedrange(self): + """ + Determines whether or not this axis is zoom-able. If true, then + zoom is disabled. + + The 'fixedrange' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["fixedrange"] + + @fixedrange.setter + def fixedrange(self, val): + self["fixedrange"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def insiderange(self): + """ + Could be used to set the desired inside range of this axis + (excluding the labels) when `ticklabelposition` of the anchored + axis has "inside". Not implemented for axes with `type` "log". + This would be ignored when `range` is provided. + + The 'insiderange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'insiderange[0]' property accepts values of any type + (1) The 'insiderange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["insiderange"] + + @insiderange.setter + def insiderange(self, val): + self["insiderange"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def matches(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis will match the range of the corresponding axis in data- + coordinates space. Moreover, matching axes share auto-range + values, category lists and histogram auto-bins. Note that + setting axes simultaneously in both a `scaleanchor` and a + `matches` constraint is currently forbidden. Moreover, note + that matching axes must have the same `type`. + + The 'matches' property is an enumeration that may be specified as: + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["matches"] + + @matches.setter + def matches(self, val): + self["matches"] = val + + @property + def maxallowed(self): + """ + Determines the maximum range of this axis. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Determines the minimum range of this axis. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def minor(self): + """ + The 'minor' property is an instance of Minor + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.Minor` + - A dict of string/value properties that will be passed + to the Minor constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.Minor + """ + return self["minor"] + + @minor.setter + def minor(self, val): + self["minor"] = val + + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self["mirror"] + + @mirror.setter + def mirror(self, val): + self["mirror"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def overlaying(self): + """ + If set a same-letter axis id, this axis is overlaid on top of + the corresponding same-letter axis, with traces and axes + visible for both axes. If False, this axis does not overlay any + same-letter axes. In this case, for axes with overlapping + domains only the highest-numbered axis will be visible. + + The 'overlaying' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['free'] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["overlaying"] + + @overlaying.setter + def overlaying(self, val): + self["overlaying"] = val + + @property + def position(self): + """ + Sets the position of this axis in the plotting space (in + normalized coordinates). Only has an effect if `anchor` is set + to "free". + + The 'position' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["position"] + + @position.setter + def position(self, val): + self["position"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + Leaving either or both elements `null` impacts the default + `autorange`. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangebreaks(self): + """ + The 'rangebreaks' property is a tuple of instances of + Rangebreak that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.yaxis.Rangebreak + - A list or tuple of dicts of string/value properties that + will be passed to the Rangebreak constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.yaxis.Rangebreak] + """ + return self["rangebreaks"] + + @rangebreaks.setter + def rangebreaks(self, val): + self["rangebreaks"] = val + + @property + def rangebreakdefaults(self): + """ + When used in a template (as + layout.template.layout.yaxis.rangebreakdefaults), sets the + default property values to use for elements of + layout.yaxis.rangebreaks + + The 'rangebreakdefaults' property is an instance of Rangebreak + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.Rangebreak` + - A dict of string/value properties that will be passed + to the Rangebreak constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.Rangebreak + """ + return self["rangebreakdefaults"] + + @rangebreakdefaults.setter + def rangebreakdefaults(self, val): + self["rangebreakdefaults"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def scaleanchor(self): + """ + If set to another axis id (e.g. `x2`, `y`), the range of this + axis changes together with the range of the corresponding axis + such that the scale of pixels per unit is in a constant ratio. + Both axes are still zoomable, but when you zoom one, the other + will zoom the same amount, keeping a fixed midpoint. + `constrain` and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: {scaleanchor: *x*}, + xaxis2: {scaleanchor: *y*}` but you can only link axes of the + same `type`. The linked axis can have the opposite letter (to + constrain the aspect ratio) or the same letter (to match scales + across subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the last + constraint encountered will be ignored to avoid possible + inconsistent constraints via `scaleratio`. Note that setting + axes simultaneously in both a `scaleanchor` and a `matches` + constraint is currently forbidden. Setting `false` allows to + remove a default constraint (occasionally, you may need to + prevent a default `scaleanchor` constraint from being applied, + eg. when having an image trace `yaxis: {scaleanchor: "x"}` is + set automatically in order for pixels to be rendered as + squares, setting `yaxis: {scaleanchor: false}` allows to remove + the constraint). + + The 'scaleanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + [False] + - A string that matches one of the following regular expressions: + ['^x([2-9]|[1-9][0-9]+)?( domain)?$', + '^y([2-9]|[1-9][0-9]+)?( domain)?$'] + + Returns + ------- + Any + """ + return self["scaleanchor"] + + @scaleanchor.setter + def scaleanchor(self, val): + self["scaleanchor"] = val + + @property + def scaleratio(self): + """ + If this axis is linked to another by `scaleanchor`, this + determines the pixel to unit scale ratio. For example, if this + value is 10, then every unit on this axis spans 10 times the + number of pixels as a unit on the linked axis. Use this for + example to create an elevation profile where the vertical scale + is exaggerated a fixed amount with respect to the horizontal. + + The 'scaleratio' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["scaleratio"] + + @scaleratio.setter + def scaleratio(self, val): + self["scaleratio"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def shift(self): + """ + Moves the axis a given number of pixels from where it would + have been otherwise. Accepts both positive and negative values, + which will shift the axis either right or left, respectively. + If `autoshift` is set to true, then this defaults to a padding + of -3 if `side` is set to "left". and defaults to +3 if `side` + is set to "right". Defaults to 0 if `autoshift` is set to + false. Only has an effect if `anchor` is set to "free". + + The 'shift' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["shift"] + + @shift.setter + def shift(self, val): + self["shift"] = val + + @property + def showdividers(self): + """ + Determines whether or not a dividers are drawn between the + category levels of this axis. Only has an effect on + "multicategory" axes. + + The 'showdividers' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showdividers"] + + @showdividers.setter + def showdividers(self, val): + self["showdividers"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showspikes(self): + """ + Determines whether or not spikes (aka droplines) are drawn for + this axis. Note: This only takes affect when hovermode = + closest + + The 'showspikes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showspikes"] + + @showspikes.setter + def showspikes(self, val): + self["showspikes"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def side(self): + """ + Determines whether a x (y) axis is positioned at the "bottom" + ("left") or "top" ("right") of the plotting area. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom', 'left', 'right'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def spikecolor(self): + """ + Sets the spike color. If undefined, will use the series color + + The 'spikecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["spikecolor"] + + @spikecolor.setter + def spikecolor(self, val): + self["spikecolor"] = val + + @property + def spikedash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'spikedash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["spikedash"] + + @spikedash.setter + def spikedash(self, val): + self["spikedash"] = val + + @property + def spikemode(self): + """ + Determines the drawing mode for the spike line If "toaxis", the + line is drawn from the data point to the axis the series is + plotted on. If "across", the line is drawn across the entire + plot area, and supercedes "toaxis". If "marker", then a marker + dot is drawn on the axis the series is plotted on + + The 'spikemode' property is a flaglist and may be specified + as a string containing: + - Any combination of ['toaxis', 'across', 'marker'] joined with '+' characters + (e.g. 'toaxis+across') + + Returns + ------- + Any + """ + return self["spikemode"] + + @spikemode.setter + def spikemode(self, val): + self["spikemode"] = val + + @property + def spikesnap(self): + """ + Determines whether spikelines are stuck to the cursor or to the + closest datapoints. + + The 'spikesnap' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['data', 'cursor', 'hovered data'] + + Returns + ------- + Any + """ + return self["spikesnap"] + + @spikesnap.setter + def spikesnap(self, val): + self["spikesnap"] = val + + @property + def spikethickness(self): + """ + Sets the width (in px) of the zero line. + + The 'spikethickness' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["spikethickness"] + + @spikethickness.setter + def spikethickness(self, val): + self["spikethickness"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.yaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.yaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.yaxis.tickformatstopdefaults), sets the + default property values to use for elements of + layout.yaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelindex(self): + """ + Only for axes with `type` "date" or "linear". Instead of + drawing the major tick label, draw the label for the minor tick + that is n positions away from the major tick. E.g. to always + draw the label for the minor tick before each major tick, + choose `ticklabelindex` -1. This is useful for date axes with + `ticklabelmode` "period" if you want to label the period that + ends with each major tick instead of the period that begins + there. + + The 'ticklabelindex' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["ticklabelindex"] + + @ticklabelindex.setter + def ticklabelindex(self, val): + self["ticklabelindex"] = val + + @property + def ticklabelindexsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `ticklabelindex`. + + The 'ticklabelindexsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticklabelindexsrc"] + + @ticklabelindexsrc.setter + def ticklabelindexsrc(self, val): + self["ticklabelindexsrc"] = val + + @property + def ticklabelmode(self): + """ + Determines where tick labels are drawn with respect to their + corresponding ticks and grid lines. Only has an effect for axes + of `type` "date" When set to "period", tick labels are drawn in + the middle of the period between ticks. + + The 'ticklabelmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['instant', 'period'] + + Returns + ------- + Any + """ + return self["ticklabelmode"] + + @ticklabelmode.setter + def ticklabelmode(self, val): + self["ticklabelmode"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. Otherwise on + "category" and "multicategory" axes the default is "allow". In + other cases the default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn with respect to the axis + Please note that top or bottom has no effect on x axes or when + `ticklabelmode` is set to "period". Similarly left or right has + no effect on y axes or when `ticklabelmode` is set to "period". + Has no effect on "multicategory" axes or when `tickson` is set + to "boundaries". When used on axes linked by `matches` or + `scaleanchor`, no extra padding for inside labels would be + added by autorange, so that the scales could match. + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelshift(self): + """ + Shifts the tick labels by the specified number of pixels in + parallel to the axis. Positive values move the labels in the + positive direction of the axis. + + The 'ticklabelshift' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["ticklabelshift"] + + @ticklabelshift.setter + def ticklabelshift(self, val): + self["ticklabelshift"] = val + + @property + def ticklabelstandoff(self): + """ + Sets the standoff distance (in px) between the axis tick labels + and their default position. A positive `ticklabelstandoff` + moves the labels farther away from the plot area if + `ticklabelposition` is "outside", and deeper into the plot area + if `ticklabelposition` is "inside". A negative + `ticklabelstandoff` works in the opposite direction, moving + outside ticks towards the plot area and inside ticks towards + the outside. If the negative value is large enough, inside + ticks can even end up outside and vice versa. + + The 'ticklabelstandoff' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["ticklabelstandoff"] + + @ticklabelstandoff.setter + def ticklabelstandoff(self, val): + self["ticklabelstandoff"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). If "sync", the + number of ticks will sync with the overlayed axis set by + `overlaying` property. + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array', 'sync'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def tickson(self): + """ + Determines where ticks and grid lines are drawn with respect to + their corresponding tick labels. Only has an effect for axes of + `type` "category" or "multicategory". When set to "boundaries", + ticks and grid lines are drawn half a category to the + left/bottom of labels. + + The 'tickson' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['labels', 'boundaries'] + + Returns + ------- + Any + """ + return self["tickson"] + + @tickson.setter + def tickson(self, val): + self["tickson"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'log', 'date', 'category', + 'multicategory'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `range`, + `autorange`, and `title` if in `editable: true` configuration. + Defaults to `layout.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def zeroline(self): + """ + Determines whether or not a line is drawn at along the 0 value + of this axis. If True, the zero line is drawn on top of the + grid lines. + + The 'zeroline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zeroline"] + + @zeroline.setter + def zeroline(self, val): + self["zeroline"] = val + + @property + def zerolinecolor(self): + """ + Sets the line color of the zero line. + + The 'zerolinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["zerolinecolor"] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self["zerolinecolor"] = val + + @property + def zerolinewidth(self): + """ + Sets the width (in px) of the zero line. + + The 'zerolinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zerolinewidth"] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self["zerolinewidth"] = val + + @property + def _prop_descriptions(self): + return """\ + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.yaxis.Autorangeopti + ons` instance or dict with compatible properties + autoshift + Automatically reposition the axis to avoid overlap with + other axes with the same `overlaying` value. This + repositioning will account for any `shift` amount + applied to other axes on the same side with `autoshift` + is set to true. Only has an effect if `anchor` is set + to "free". + autotickangles + When `tickangle` is set to "auto", it will be set to + the first angle in this array that is large enough to + prevent label overlap. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range", or by decreasing the "domain". Default is + "domain" for axes containing image traces, "range" + otherwise. + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + insiderange + Could be used to set the desired inside range of this + axis (excluding the labels) when `ticklabelposition` of + the anchored axis has "inside". Not implemented for + axes with `type` "log". This would be ignored when + `range` is provided. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + minor + :class:`plotly.graph_objects.layout.yaxis.Minor` + instance or dict with compatible properties + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangebreaks + A tuple of + :class:`plotly.graph_objects.layout.yaxis.Rangebreak` + instances or dicts with compatible properties + rangebreakdefaults + When used in a template (as + layout.template.layout.yaxis.rangebreakdefaults), sets + the default property values to use for elements of + layout.yaxis.rangebreaks + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. Setting `false` allows to remove a default + constraint (occasionally, you may need to prevent a + default `scaleanchor` constraint from being applied, + eg. when having an image trace `yaxis: {scaleanchor: + "x"}` is set automatically in order for pixels to be + rendered as squares, setting `yaxis: {scaleanchor: + false}` allows to remove the constraint). + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + shift + Moves the axis a given number of pixels from where it + would have been otherwise. Accepts both positive and + negative values, which will shift the axis either right + or left, respectively. If `autoshift` is set to true, + then this defaults to a padding of -3 if `side` is set + to "left". and defaults to +3 if `side` is set to + "right". Defaults to 0 if `autoshift` is set to false. + Only has an effect if `anchor` is set to "free". + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.yaxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.yaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.yaxis.tickformatstops + ticklabelindex + Only for axes with `type` "date" or "linear". Instead + of drawing the major tick label, draw the label for the + minor tick that is n positions away from the major + tick. E.g. to always draw the label for the minor tick + before each major tick, choose `ticklabelindex` -1. + This is useful for date axes with `ticklabelmode` + "period" if you want to label the period that ends with + each major tick instead of the period that begins + there. + ticklabelindexsrc + Sets the source reference on Chart Studio Cloud for + `ticklabelindex`. + ticklabelmode + Determines where tick labels are drawn with respect to + their corresponding ticks and grid lines. Only has an + effect for axes of `type` "date" When set to "period", + tick labels are drawn in the middle of the period + between ticks. + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. Otherwise on "category" and + "multicategory" axes the default is "allow". In other + cases the default is *hide past div*. + ticklabelposition + Determines where tick labels are drawn with respect to + the axis Please note that top or bottom has no effect + on x axes or when `ticklabelmode` is set to "period". + Similarly left or right has no effect on y axes or when + `ticklabelmode` is set to "period". Has no effect on + "multicategory" axes or when `tickson` is set to + "boundaries". When used on axes linked by `matches` or + `scaleanchor`, no extra padding for inside labels would + be added by autorange, so that the scales could match. + ticklabelshift + Shifts the tick labels by the specified number of + pixels in parallel to the axis. Positive values move + the labels in the positive direction of the axis. + ticklabelstandoff + Sets the standoff distance (in px) between the axis + tick labels and their default position. A positive + `ticklabelstandoff` moves the labels farther away from + the plot area if `ticklabelposition` is "outside", and + deeper into the plot area if `ticklabelposition` is + "inside". A negative `ticklabelstandoff` works in the + opposite direction, moving outside ticks towards the + plot area and inside ticks towards the outside. If the + negative value is large enough, inside ticks can even + end up outside and vice versa. + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). If + "sync", the number of ticks will sync with the + overlayed axis set by `overlaying` property. + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.yaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + def __init__( + self, + arg=None, + anchor=None, + automargin=None, + autorange=None, + autorangeoptions=None, + autoshift=None, + autotickangles=None, + autotypenumbers=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + constrain=None, + constraintoward=None, + dividercolor=None, + dividerwidth=None, + domain=None, + dtick=None, + exponentformat=None, + fixedrange=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + insiderange=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + matches=None, + maxallowed=None, + minallowed=None, + minexponent=None, + minor=None, + mirror=None, + nticks=None, + overlaying=None, + position=None, + range=None, + rangebreaks=None, + rangebreakdefaults=None, + rangemode=None, + scaleanchor=None, + scaleratio=None, + separatethousands=None, + shift=None, + showdividers=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + spikecolor=None, + spikedash=None, + spikemode=None, + spikesnap=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelindex=None, + ticklabelindexsrc=None, + ticklabelmode=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelshift=None, + ticklabelstandoff=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + tickson=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + type=None, + uirevision=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs, + ): + """ + Construct a new YAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.YAxis` + anchor + If set to an opposite-letter axis id (e.g. `x2`, `y`), + this axis is bound to the corresponding opposite-letter + axis. If set to "free", this axis' position is + determined by `position`. + automargin + Determines whether long tick labels automatically grow + the figure margins. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.yaxis.Autorangeopti + ons` instance or dict with compatible properties + autoshift + Automatically reposition the axis to avoid overlap with + other axes with the same `overlaying` value. This + repositioning will account for any `shift` amount + applied to other axes on the same side with `autoshift` + is set to true. Only has an effect if `anchor` is set + to "free". + autotickangles + When `tickangle` is set to "auto", it will be set to + the first angle in this array that is large enough to + prevent label overlap. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + constrain + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines how that happens: by increasing + the "range", or by decreasing the "domain". Default is + "domain" for axes containing image traces, "range" + otherwise. + constraintoward + If this axis needs to be compressed (either due to its + own `scaleanchor` and `scaleratio` or those of the + other axis), determines which direction we push the + originally specified plot area. Options are "left", + "center" (default), and "right" for x axes, and "top", + "middle" (default), and "bottom" for y axes. + dividercolor + Sets the color of the dividers Only has an effect on + "multicategory" axes. + dividerwidth + Sets the width (in px) of the dividers Only has an + effect on "multicategory" axes. + domain + Sets the domain of this axis (in plot fraction). + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + fixedrange + Determines whether or not this axis is zoom-able. If + true, then zoom is disabled. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + insiderange + Could be used to set the desired inside range of this + axis (excluding the labels) when `ticklabelposition` of + the anchored axis has "inside". Not implemented for + axes with `type` "log". This would be ignored when + `range` is provided. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + matches + If set to another axis id (e.g. `x2`, `y`), the range + of this axis will match the range of the corresponding + axis in data-coordinates space. Moreover, matching axes + share auto-range values, category lists and histogram + auto-bins. Note that setting axes simultaneously in + both a `scaleanchor` and a `matches` constraint is + currently forbidden. Moreover, note that matching axes + must have the same `type`. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + minor + :class:`plotly.graph_objects.layout.yaxis.Minor` + instance or dict with compatible properties + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + overlaying + If set a same-letter axis id, this axis is overlaid on + top of the corresponding same-letter axis, with traces + and axes visible for both axes. If False, this axis + does not overlay any same-letter axes. In this case, + for axes with overlapping domains only the highest- + numbered axis will be visible. + position + Sets the position of this axis in the plotting space + (in normalized coordinates). Only has an effect if + `anchor` is set to "free". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangebreaks + A tuple of + :class:`plotly.graph_objects.layout.yaxis.Rangebreak` + instances or dicts with compatible properties + rangebreakdefaults + When used in a template (as + layout.template.layout.yaxis.rangebreakdefaults), sets + the default property values to use for elements of + layout.yaxis.rangebreaks + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + scaleanchor + If set to another axis id (e.g. `x2`, `y`), the range + of this axis changes together with the range of the + corresponding axis such that the scale of pixels per + unit is in a constant ratio. Both axes are still + zoomable, but when you zoom one, the other will zoom + the same amount, keeping a fixed midpoint. `constrain` + and `constraintoward` determine how we enforce the + constraint. You can chain these, ie `yaxis: + {scaleanchor: *x*}, xaxis2: {scaleanchor: *y*}` but you + can only link axes of the same `type`. The linked axis + can have the opposite letter (to constrain the aspect + ratio) or the same letter (to match scales across + subplots). Loops (`yaxis: {scaleanchor: *x*}, xaxis: + {scaleanchor: *y*}` or longer) are redundant and the + last constraint encountered will be ignored to avoid + possible inconsistent constraints via `scaleratio`. + Note that setting axes simultaneously in both a + `scaleanchor` and a `matches` constraint is currently + forbidden. Setting `false` allows to remove a default + constraint (occasionally, you may need to prevent a + default `scaleanchor` constraint from being applied, + eg. when having an image trace `yaxis: {scaleanchor: + "x"}` is set automatically in order for pixels to be + rendered as squares, setting `yaxis: {scaleanchor: + false}` allows to remove the constraint). + scaleratio + If this axis is linked to another by `scaleanchor`, + this determines the pixel to unit scale ratio. For + example, if this value is 10, then every unit on this + axis spans 10 times the number of pixels as a unit on + the linked axis. Use this for example to create an + elevation profile where the vertical scale is + exaggerated a fixed amount with respect to the + horizontal. + separatethousands + If "true", even 4-digit integers are separated + shift + Moves the axis a given number of pixels from where it + would have been otherwise. Accepts both positive and + negative values, which will shift the axis either right + or left, respectively. If `autoshift` is set to true, + then this defaults to a padding of -3 if `side` is set + to "left". and defaults to +3 if `side` is set to + "right". Defaults to 0 if `autoshift` is set to false. + Only has an effect if `anchor` is set to "free". + showdividers + Determines whether or not a dividers are drawn between + the category levels of this axis. Only has an effect on + "multicategory" axes. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Determines whether or not spikes (aka droplines) are + drawn for this axis. Note: This only takes affect when + hovermode = closest + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines whether a x (y) axis is positioned at the + "bottom" ("left") or "top" ("right") of the plotting + area. + spikecolor + Sets the spike color. If undefined, will use the series + color + spikedash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + spikemode + Determines the drawing mode for the spike line If + "toaxis", the line is drawn from the data point to the + axis the series is plotted on. If "across", the line + is drawn across the entire plot area, and supercedes + "toaxis". If "marker", then a marker dot is drawn on + the axis the series is plotted on + spikesnap + Determines whether spikelines are stuck to the cursor + or to the closest datapoints. + spikethickness + Sets the width (in px) of the zero line. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.yaxis.Ti + ckformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as + layout.template.layout.yaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.yaxis.tickformatstops + ticklabelindex + Only for axes with `type` "date" or "linear". Instead + of drawing the major tick label, draw the label for the + minor tick that is n positions away from the major + tick. E.g. to always draw the label for the minor tick + before each major tick, choose `ticklabelindex` -1. + This is useful for date axes with `ticklabelmode` + "period" if you want to label the period that ends with + each major tick instead of the period that begins + there. + ticklabelindexsrc + Sets the source reference on Chart Studio Cloud for + `ticklabelindex`. + ticklabelmode + Determines where tick labels are drawn with respect to + their corresponding ticks and grid lines. Only has an + effect for axes of `type` "date" When set to "period", + tick labels are drawn in the middle of the period + between ticks. + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. Otherwise on "category" and + "multicategory" axes the default is "allow". In other + cases the default is *hide past div*. + ticklabelposition + Determines where tick labels are drawn with respect to + the axis Please note that top or bottom has no effect + on x axes or when `ticklabelmode` is set to "period". + Similarly left or right has no effect on y axes or when + `ticklabelmode` is set to "period". Has no effect on + "multicategory" axes or when `tickson` is set to + "boundaries". When used on axes linked by `matches` or + `scaleanchor`, no extra padding for inside labels would + be added by autorange, so that the scales could match. + ticklabelshift + Shifts the tick labels by the specified number of + pixels in parallel to the axis. Positive values move + the labels in the positive direction of the axis. + ticklabelstandoff + Sets the standoff distance (in px) between the axis + tick labels and their default position. A positive + `ticklabelstandoff` moves the labels farther away from + the plot area if `ticklabelposition` is "outside", and + deeper into the plot area if `ticklabelposition` is + "inside". A negative `ticklabelstandoff` works in the + opposite direction, moving outside ticks towards the + plot area and inside ticks towards the outside. If the + negative value is large enough, inside ticks can even + end up outside and vice versa. + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). If + "sync", the number of ticks will sync with the + overlayed axis set by `overlaying` property. + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickson + Determines where ticks and grid lines are drawn with + respect to their corresponding tick labels. Only has an + effect for axes of `type` "category" or + "multicategory". When set to "boundaries", ticks and + grid lines are drawn half a category to the left/bottom + of labels. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.yaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, and `title` if in `editable: + true` configuration. Defaults to `layout.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + YAxis + """ + super().__init__("yaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.YAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.YAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("anchor", arg, anchor) + self._set_property("automargin", arg, automargin) + self._set_property("autorange", arg, autorange) + self._set_property("autorangeoptions", arg, autorangeoptions) + self._set_property("autoshift", arg, autoshift) + self._set_property("autotickangles", arg, autotickangles) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("calendar", arg, calendar) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("constrain", arg, constrain) + self._set_property("constraintoward", arg, constraintoward) + self._set_property("dividercolor", arg, dividercolor) + self._set_property("dividerwidth", arg, dividerwidth) + self._set_property("domain", arg, domain) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("fixedrange", arg, fixedrange) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("insiderange", arg, insiderange) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("matches", arg, matches) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._set_property("minexponent", arg, minexponent) + self._set_property("minor", arg, minor) + self._set_property("mirror", arg, mirror) + self._set_property("nticks", arg, nticks) + self._set_property("overlaying", arg, overlaying) + self._set_property("position", arg, position) + self._set_property("range", arg, range) + self._set_property("rangebreaks", arg, rangebreaks) + self._set_property("rangebreakdefaults", arg, rangebreakdefaults) + self._set_property("rangemode", arg, rangemode) + self._set_property("scaleanchor", arg, scaleanchor) + self._set_property("scaleratio", arg, scaleratio) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("shift", arg, shift) + self._set_property("showdividers", arg, showdividers) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showspikes", arg, showspikes) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("side", arg, side) + self._set_property("spikecolor", arg, spikecolor) + self._set_property("spikedash", arg, spikedash) + self._set_property("spikemode", arg, spikemode) + self._set_property("spikesnap", arg, spikesnap) + self._set_property("spikethickness", arg, spikethickness) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelindex", arg, ticklabelindex) + self._set_property("ticklabelindexsrc", arg, ticklabelindexsrc) + self._set_property("ticklabelmode", arg, ticklabelmode) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelshift", arg, ticklabelshift) + self._set_property("ticklabelstandoff", arg, ticklabelstandoff) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("tickson", arg, tickson) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._set_property("zeroline", arg, zeroline) + self._set_property("zerolinecolor", arg, zerolinecolor) + self._set_property("zerolinewidth", arg, zerolinewidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/__init__.py new file mode 100644 index 0000000..372a9f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font + from ._hoverlabel import Hoverlabel + from . import hoverlabel +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".hoverlabel"], ["._font.Font", "._hoverlabel.Hoverlabel"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_font.py new file mode 100644 index 0000000..736edb1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.annotation" + _path_str = "layout.annotation.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the annotation text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.annotation.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.annotation.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.annotation.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_hoverlabel.py new file mode 100644 index 0000000..ee847b2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/_hoverlabel.py @@ -0,0 +1,151 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseLayoutHierarchyType): + _parent_path_str = "layout.annotation" + _path_str = "layout.annotation.hoverlabel" + _valid_props = {"bgcolor", "bordercolor", "font"} + + @property + def bgcolor(self): + """ + Sets the background color of the hover label. By default uses + the annotation's `bgcolor` made opaque, or white if it was + transparent. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover label. By default uses + either dark grey or white, for maximum contrast with + `hoverlabel.bgcolor`. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def font(self): + """ + Sets the hover label text font. By default uses the global + hover font and size, with color from `hoverlabel.bordercolor`. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.annotation.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.annotation.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + """ + + def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.annotation.Hoverlabel` + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.annotation.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.annotation.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("font", arg, font) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/_font.py new file mode 100644 index 0000000..b3a561e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/annotation/hoverlabel/_font.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.annotation.hoverlabel" + _path_str = "layout.annotation.hoverlabel.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the hover label text font. By default uses the global + hover font and size, with color from `hoverlabel.bordercolor`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.annotat + ion.hoverlabel.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.annotation.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.annotation.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/__init__.py new file mode 100644 index 0000000..5e06f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/_colorbar.py new file mode 100644 index 0000000..0749ad3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class ColorBar(_BaseLayoutHierarchyType): + _parent_path_str = "layout.coloraxis" + _path_str = "layout.coloraxis.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.coloraxis.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.layout.coloraxis.co + lorbar.tickformatstopdefaults), sets the default property + values to use for elements of + layout.coloraxis.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.coloraxis.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.coloraxi + s.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.colo + raxis.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + layout.coloraxis.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.coloraxis.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.coloraxis.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.coloraxi + s.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.colo + raxis.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + layout.coloraxis.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.coloraxis.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.coloraxis.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.coloraxis.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py new file mode 100644 index 0000000..146bfec --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.coloraxis.colorbar" + _path_str = "layout.coloraxis.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py new file mode 100644 index 0000000..2a971e1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.coloraxis.colorbar" + _path_str = "layout.coloraxis.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_title.py new file mode 100644 index 0000000..3f906c7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.coloraxis.colorbar" + _path_str = "layout.coloraxis.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.coloraxis.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py new file mode 100644 index 0000000..d151ff3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/coloraxis/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.coloraxis.colorbar.title" + _path_str = "layout.coloraxis.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.colorax + is.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.coloraxis.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.coloraxis.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/__init__.py new file mode 100644 index 0000000..22d3516 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/__init__.py @@ -0,0 +1,24 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._center import Center + from ._domain import Domain + from ._lataxis import Lataxis + from ._lonaxis import Lonaxis + from ._projection import Projection + from . import projection +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".projection"], + [ + "._center.Center", + "._domain.Domain", + "._lataxis.Lataxis", + "._lonaxis.Lonaxis", + "._projection.Projection", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_center.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_center.py new file mode 100644 index 0000000..059d3a4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_center.py @@ -0,0 +1,115 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + _parent_path_str = "layout.geo" + _path_str = "layout.geo.center" + _valid_props = {"lat", "lon"} + + @property + def lat(self): + """ + Sets the latitude of the map's center. For all projection + types, the map's latitude center lies at the middle of the + latitude range by default. + + The 'lat' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def lon(self): + """ + Sets the longitude of the map's center. By default, the map's + longitude center lies at the middle of the longitude range for + scoped projection and above `projection.rotation.lon` + otherwise. + + The 'lon' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def _prop_descriptions(self): + return """\ + lat + Sets the latitude of the map's center. For all + projection types, the map's latitude center lies at the + middle of the latitude range by default. + lon + Sets the longitude of the map's center. By default, the + map's longitude center lies at the middle of the + longitude range for scoped projection and above + `projection.rotation.lon` otherwise. + """ + + def __init__(self, arg=None, lat=None, lon=None, **kwargs): + """ + Construct a new Center object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.geo.Center` + lat + Sets the latitude of the map's center. For all + projection types, the map's latitude center lies at the + middle of the latitude range by default. + lon + Sets the longitude of the map's center. By default, the + map's longitude center lies at the middle of the + longitude range for scoped projection and above + `projection.rotation.lon` otherwise. + + Returns + ------- + Center + """ + super().__init__("center") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.geo.Center +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.geo.Center`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("lat", arg, lat) + self._set_property("lon", arg, lon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_domain.py new file mode 100644 index 0000000..1869b41 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_domain.py @@ -0,0 +1,204 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.geo" + _path_str = "layout.geo.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this geo subplot . Note that geo subplots are + constrained by domain. In general, when `projection.scale` is + set to 1. a map will fit either its x or y domain, but not + both. + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this geo subplot . Note that geo subplots are + constrained by domain. In general, when `projection.scale` is + set to 1. a map will fit either its x or y domain, but not + both. + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this geo subplot (in plot + fraction). Note that geo subplots are constrained by domain. In + general, when `projection.scale` is set to 1. a map will fit + either its x or y domain, but not both. + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this geo subplot (in plot + fraction). Note that geo subplots are constrained by domain. In + general, when `projection.scale` is set to 1. a map will fit + either its x or y domain, but not both. + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this geo subplot . Note that geo + subplots are constrained by domain. In general, when + `projection.scale` is set to 1. a map will fit either + its x or y domain, but not both. + row + If there is a layout grid, use the domain for this row + in the grid for this geo subplot . Note that geo + subplots are constrained by domain. In general, when + `projection.scale` is set to 1. a map will fit either + its x or y domain, but not both. + x + Sets the horizontal domain of this geo subplot (in plot + fraction). Note that geo subplots are constrained by + domain. In general, when `projection.scale` is set to + 1. a map will fit either its x or y domain, but not + both. + y + Sets the vertical domain of this geo subplot (in plot + fraction). Note that geo subplots are constrained by + domain. In general, when `projection.scale` is set to + 1. a map will fit either its x or y domain, but not + both. + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.geo.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this geo subplot . Note that geo + subplots are constrained by domain. In general, when + `projection.scale` is set to 1. a map will fit either + its x or y domain, but not both. + row + If there is a layout grid, use the domain for this row + in the grid for this geo subplot . Note that geo + subplots are constrained by domain. In general, when + `projection.scale` is set to 1. a map will fit either + its x or y domain, but not both. + x + Sets the horizontal domain of this geo subplot (in plot + fraction). Note that geo subplots are constrained by + domain. In general, when `projection.scale` is set to + 1. a map will fit either its x or y domain, but not + both. + y + Sets the vertical domain of this geo subplot (in plot + fraction). Note that geo subplots are constrained by + domain. In general, when `projection.scale` is set to + 1. a map will fit either its x or y domain, but not + both. + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.geo.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.geo.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lataxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lataxis.py new file mode 100644 index 0000000..fcaf4c8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lataxis.py @@ -0,0 +1,258 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Lataxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.geo" + _path_str = "layout.geo.lataxis" + _valid_props = { + "dtick", + "gridcolor", + "griddash", + "gridwidth", + "range", + "showgrid", + "tick0", + } + + @property + def dtick(self): + """ + Sets the graticule's longitude/latitude tick step. + + The 'dtick' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def gridcolor(self): + """ + Sets the graticule's stroke color. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the graticule's stroke width (in px). + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def range(self): + """ + Sets the range of this axis (in degrees), sets the map's + clipped coordinates. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property is a number and may be specified as: + - An int or float + (1) The 'range[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def showgrid(self): + """ + Sets whether or not graticule are shown on the map. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def tick0(self): + """ + Sets the graticule's starting tick longitude/latitude. + + The 'tick0' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + """ + + def __init__( + self, + arg=None, + dtick=None, + gridcolor=None, + griddash=None, + gridwidth=None, + range=None, + showgrid=None, + tick0=None, + **kwargs, + ): + """ + Construct a new Lataxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.geo.Lataxis` + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + + Returns + ------- + Lataxis + """ + super().__init__("lataxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.geo.Lataxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.geo.Lataxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtick", arg, dtick) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("range", arg, range) + self._set_property("showgrid", arg, showgrid) + self._set_property("tick0", arg, tick0) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lonaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lonaxis.py new file mode 100644 index 0000000..6b31527 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_lonaxis.py @@ -0,0 +1,258 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Lonaxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.geo" + _path_str = "layout.geo.lonaxis" + _valid_props = { + "dtick", + "gridcolor", + "griddash", + "gridwidth", + "range", + "showgrid", + "tick0", + } + + @property + def dtick(self): + """ + Sets the graticule's longitude/latitude tick step. + + The 'dtick' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def gridcolor(self): + """ + Sets the graticule's stroke color. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the graticule's stroke width (in px). + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def range(self): + """ + Sets the range of this axis (in degrees), sets the map's + clipped coordinates. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property is a number and may be specified as: + - An int or float + (1) The 'range[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def showgrid(self): + """ + Sets whether or not graticule are shown on the map. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def tick0(self): + """ + Sets the graticule's starting tick longitude/latitude. + + The 'tick0' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + """ + + def __init__( + self, + arg=None, + dtick=None, + gridcolor=None, + griddash=None, + gridwidth=None, + range=None, + showgrid=None, + tick0=None, + **kwargs, + ): + """ + Construct a new Lonaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.geo.Lonaxis` + dtick + Sets the graticule's longitude/latitude tick step. + gridcolor + Sets the graticule's stroke color. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the graticule's stroke width (in px). + range + Sets the range of this axis (in degrees), sets the + map's clipped coordinates. + showgrid + Sets whether or not graticule are shown on the map. + tick0 + Sets the graticule's starting tick longitude/latitude. + + Returns + ------- + Lonaxis + """ + super().__init__("lonaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.geo.Lonaxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.geo.Lonaxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtick", arg, dtick) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("range", arg, range) + self._set_property("showgrid", arg, showgrid) + self._set_property("tick0", arg, tick0) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_projection.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_projection.py new file mode 100644 index 0000000..fb8a539 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/_projection.py @@ -0,0 +1,251 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Projection(_BaseLayoutHierarchyType): + _parent_path_str = "layout.geo" + _path_str = "layout.geo.projection" + _valid_props = {"distance", "parallels", "rotation", "scale", "tilt", "type"} + + @property + def distance(self): + """ + For satellite projection type only. Sets the distance from the + center of the sphere to the point of view as a proportion of + the sphere’s radius. + + The 'distance' property is a number and may be specified as: + - An int or float in the interval [1.001, inf] + + Returns + ------- + int|float + """ + return self["distance"] + + @distance.setter + def distance(self, val): + self["distance"] = val + + @property + def parallels(self): + """ + For conic projection types only. Sets the parallels (tangent, + secant) where the cone intersects the sphere. + + The 'parallels' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'parallels[0]' property is a number and may be specified as: + - An int or float + (1) The 'parallels[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["parallels"] + + @parallels.setter + def parallels(self, val): + self["parallels"] = val + + @property + def rotation(self): + """ + The 'rotation' property is an instance of Rotation + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.geo.projection.Rotation` + - A dict of string/value properties that will be passed + to the Rotation constructor + + Returns + ------- + plotly.graph_objs.layout.geo.projection.Rotation + """ + return self["rotation"] + + @rotation.setter + def rotation(self, val): + self["rotation"] = val + + @property + def scale(self): + """ + Zooms in or out on the map view. A scale of 1 corresponds to + the largest zoom level that fits the map's lon and lat ranges. + + The 'scale' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["scale"] + + @scale.setter + def scale(self, val): + self["scale"] = val + + @property + def tilt(self): + """ + For satellite projection type only. Sets the tilt angle of + perspective projection. + + The 'tilt' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["tilt"] + + @tilt.setter + def tilt(self, val): + self["tilt"] = val + + @property + def type(self): + """ + Sets the projection type. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['airy', 'aitoff', 'albers', 'albers usa', 'august', + 'azimuthal equal area', 'azimuthal equidistant', 'baker', + 'bertin1953', 'boggs', 'bonne', 'bottomley', 'bromley', + 'collignon', 'conic conformal', 'conic equal area', 'conic + equidistant', 'craig', 'craster', 'cylindrical equal + area', 'cylindrical stereographic', 'eckert1', 'eckert2', + 'eckert3', 'eckert4', 'eckert5', 'eckert6', 'eisenlohr', + 'equal earth', 'equirectangular', 'fahey', 'foucaut', + 'foucaut sinusoidal', 'ginzburg4', 'ginzburg5', + 'ginzburg6', 'ginzburg8', 'ginzburg9', 'gnomonic', + 'gringorten', 'gringorten quincuncial', 'guyou', 'hammer', + 'hill', 'homolosine', 'hufnagel', 'hyperelliptical', + 'kavrayskiy7', 'lagrange', 'larrivee', 'laskowski', + 'loximuthal', 'mercator', 'miller', 'mollweide', 'mt flat + polar parabolic', 'mt flat polar quartic', 'mt flat polar + sinusoidal', 'natural earth', 'natural earth1', 'natural + earth2', 'nell hammer', 'nicolosi', 'orthographic', + 'patterson', 'peirce quincuncial', 'polyconic', + 'rectangular polyconic', 'robinson', 'satellite', 'sinu + mollweide', 'sinusoidal', 'stereographic', 'times', + 'transverse mercator', 'van der grinten', 'van der + grinten2', 'van der grinten3', 'van der grinten4', + 'wagner4', 'wagner6', 'wiechel', 'winkel tripel', + 'winkel3'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def _prop_descriptions(self): + return """\ + distance + For satellite projection type only. Sets the distance + from the center of the sphere to the point of view as a + proportion of the sphere’s radius. + parallels + For conic projection types only. Sets the parallels + (tangent, secant) where the cone intersects the sphere. + rotation + :class:`plotly.graph_objects.layout.geo.projection.Rota + tion` instance or dict with compatible properties + scale + Zooms in or out on the map view. A scale of 1 + corresponds to the largest zoom level that fits the + map's lon and lat ranges. + tilt + For satellite projection type only. Sets the tilt angle + of perspective projection. + type + Sets the projection type. + """ + + def __init__( + self, + arg=None, + distance=None, + parallels=None, + rotation=None, + scale=None, + tilt=None, + type=None, + **kwargs, + ): + """ + Construct a new Projection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.geo.Projection` + distance + For satellite projection type only. Sets the distance + from the center of the sphere to the point of view as a + proportion of the sphere’s radius. + parallels + For conic projection types only. Sets the parallels + (tangent, secant) where the cone intersects the sphere. + rotation + :class:`plotly.graph_objects.layout.geo.projection.Rota + tion` instance or dict with compatible properties + scale + Zooms in or out on the map view. A scale of 1 + corresponds to the largest zoom level that fits the + map's lon and lat ranges. + tilt + For satellite projection type only. Sets the tilt angle + of perspective projection. + type + Sets the projection type. + + Returns + ------- + Projection + """ + super().__init__("projection") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.geo.Projection +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.geo.Projection`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("distance", arg, distance) + self._set_property("parallels", arg, parallels) + self._set_property("rotation", arg, rotation) + self._set_property("scale", arg, scale) + self._set_property("tilt", arg, tilt) + self._set_property("type", arg, type) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/__init__.py new file mode 100644 index 0000000..7354e48 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._rotation import Rotation +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._rotation.Rotation"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/_rotation.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/_rotation.py new file mode 100644 index 0000000..4934597 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/geo/projection/_rotation.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rotation(_BaseLayoutHierarchyType): + _parent_path_str = "layout.geo.projection" + _path_str = "layout.geo.projection.rotation" + _valid_props = {"lat", "lon", "roll"} + + @property + def lat(self): + """ + Rotates the map along meridians (in degrees North). + + The 'lat' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def lon(self): + """ + Rotates the map along parallels (in degrees East). Defaults to + the center of the `lonaxis.range` values. + + The 'lon' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def roll(self): + """ + Roll the map (in degrees) For example, a roll of 180 makes the + map appear upside down. + + The 'roll' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["roll"] + + @roll.setter + def roll(self, val): + self["roll"] = val + + @property + def _prop_descriptions(self): + return """\ + lat + Rotates the map along meridians (in degrees North). + lon + Rotates the map along parallels (in degrees East). + Defaults to the center of the `lonaxis.range` values. + roll + Roll the map (in degrees) For example, a roll of 180 + makes the map appear upside down. + """ + + def __init__(self, arg=None, lat=None, lon=None, roll=None, **kwargs): + """ + Construct a new Rotation object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.geo.pro + jection.Rotation` + lat + Rotates the map along meridians (in degrees North). + lon + Rotates the map along parallels (in degrees East). + Defaults to the center of the `lonaxis.range` values. + roll + Roll the map (in degrees) For example, a roll of 180 + makes the map appear upside down. + + Returns + ------- + Rotation + """ + super().__init__("rotation") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.geo.projection.Rotation +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.geo.projection.Rotation`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("lat", arg, lat) + self._set_property("lon", arg, lon) + self._set_property("roll", arg, roll) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/__init__.py new file mode 100644 index 0000000..672daf1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._domain.Domain"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/_domain.py new file mode 100644 index 0000000..1e1fc2f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/grid/_domain.py @@ -0,0 +1,122 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.grid" + _path_str = "layout.grid.domain" + _valid_props = {"x", "y"} + + @property + def x(self): + """ + Sets the horizontal domain of this grid subplot (in plot + fraction). The first and last cells end exactly at the domain + edges, with no grout around the edges. + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this grid subplot (in plot + fraction). The first and last cells end exactly at the domain + edges, with no grout around the edges. + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Sets the horizontal domain of this grid subplot (in + plot fraction). The first and last cells end exactly at + the domain edges, with no grout around the edges. + y + Sets the vertical domain of this grid subplot (in plot + fraction). The first and last cells end exactly at the + domain edges, with no grout around the edges. + """ + + def __init__(self, arg=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.grid.Domain` + x + Sets the horizontal domain of this grid subplot (in + plot fraction). The first and last cells end exactly at + the domain edges, with no grout around the edges. + y + Sets the vertical domain of this grid subplot (in plot + fraction). The first and last cells end exactly at the + domain edges, with no grout around the edges. + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.grid.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.grid.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/__init__.py new file mode 100644 index 0000000..c1800c3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font + from ._grouptitlefont import Grouptitlefont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._font.Font", "._grouptitlefont.Grouptitlefont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_font.py new file mode 100644 index 0000000..afaef5d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_font.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.hoverlabel" + _path_str = "layout.hoverlabel.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the default hover label font used by all traces on the + graph. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.hoverlabel.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_grouptitlefont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_grouptitlefont.py new file mode 100644 index 0000000..f1aae36 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/hoverlabel/_grouptitlefont.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Grouptitlefont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.hoverlabel" + _path_str = "layout.hoverlabel.grouptitlefont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Grouptitlefont object + + Sets the font for group titles in hover (unified modes). + Defaults to `hoverlabel.font`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.hoverla + bel.Grouptitlefont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Grouptitlefont + """ + super().__init__("grouptitlefont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.hoverlabel.Grouptitlefont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.hoverlabel.Grouptitlefont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/__init__.py new file mode 100644 index 0000000..74cf3d2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font + from ._grouptitlefont import Grouptitlefont + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._font.Font", "._grouptitlefont.Grouptitlefont", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_font.py new file mode 100644 index 0000000..5b1eedf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.legend" + _path_str = "layout.legend.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used to text the legend items. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.legend.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.legend.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.legend.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_grouptitlefont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_grouptitlefont.py new file mode 100644 index 0000000..1dc1285 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_grouptitlefont.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Grouptitlefont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.legend" + _path_str = "layout.legend.grouptitlefont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Grouptitlefont object + + Sets the font for group titles in legend. Defaults to + `legend.font` with its size increased about 10%. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.legend.Grouptitlefont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Grouptitlefont + """ + super().__init__("grouptitlefont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.legend.Grouptitlefont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.legend.Grouptitlefont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_title.py new file mode 100644 index 0000000..a0c67bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/_title.py @@ -0,0 +1,145 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.legend" + _path_str = "layout.legend.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this legend's title font. Defaults to `legend.font` with + its size increased about 20%. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.legend.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.legend.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of legend's title with respect to the + legend items. Defaulted to "top" with `orientation` is "h". + Defaulted to "left" with `orientation` is "v". The *top left* + options could be used to expand top center and top right are + for horizontal alignment legend area in both x and y sides. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'left', 'top left', 'top center', 'top right'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the legend. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend's title font. Defaults to + `legend.font` with its size increased about 20%. + side + Determines the location of legend's title with respect + to the legend items. Defaulted to "top" with + `orientation` is "h". Defaulted to "left" with + `orientation` is "v". The *top left* options could be + used to expand top center and top right are for + horizontal alignment legend area in both x and y sides. + text + Sets the title of the legend. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.legend.Title` + font + Sets this legend's title font. Defaults to + `legend.font` with its size increased about 20%. + side + Determines the location of legend's title with respect + to the legend items. Defaulted to "top" with + `orientation` is "h". Defaulted to "left" with + `orientation` is "v". The *top left* options could be + used to expand top center and top right are for + horizontal alignment legend area in both x and y sides. + text + Sets the title of the legend. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.legend.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.legend.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/_font.py new file mode 100644 index 0000000..1deec6a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/legend/title/_font.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.legend.title" + _path_str = "layout.legend.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend's title font. Defaults to `legend.font` with + its size increased about 20%. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.legend.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.legend.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.legend.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/__init__.py new file mode 100644 index 0000000..929c41c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._bounds import Bounds + from ._center import Center + from ._domain import Domain + from ._layer import Layer + from . import layer +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".layer"], + ["._bounds.Bounds", "._center.Center", "._domain.Domain", "._layer.Layer"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_bounds.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_bounds.py new file mode 100644 index 0000000..13e914c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_bounds.py @@ -0,0 +1,160 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Bounds(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map" + _path_str = "layout.map.bounds" + _valid_props = {"east", "north", "south", "west"} + + @property + def east(self): + """ + Sets the maximum longitude of the map (in degrees East) if + `west`, `south` and `north` are declared. + + The 'east' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["east"] + + @east.setter + def east(self, val): + self["east"] = val + + @property + def north(self): + """ + Sets the maximum latitude of the map (in degrees North) if + `east`, `west` and `south` are declared. + + The 'north' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["north"] + + @north.setter + def north(self, val): + self["north"] = val + + @property + def south(self): + """ + Sets the minimum latitude of the map (in degrees North) if + `east`, `west` and `north` are declared. + + The 'south' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["south"] + + @south.setter + def south(self, val): + self["south"] = val + + @property + def west(self): + """ + Sets the minimum longitude of the map (in degrees East) if + `east`, `south` and `north` are declared. + + The 'west' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["west"] + + @west.setter + def west(self, val): + self["west"] = val + + @property + def _prop_descriptions(self): + return """\ + east + Sets the maximum longitude of the map (in degrees East) + if `west`, `south` and `north` are declared. + north + Sets the maximum latitude of the map (in degrees North) + if `east`, `west` and `south` are declared. + south + Sets the minimum latitude of the map (in degrees North) + if `east`, `west` and `north` are declared. + west + Sets the minimum longitude of the map (in degrees East) + if `east`, `south` and `north` are declared. + """ + + def __init__( + self, arg=None, east=None, north=None, south=None, west=None, **kwargs + ): + """ + Construct a new Bounds object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.Bounds` + east + Sets the maximum longitude of the map (in degrees East) + if `west`, `south` and `north` are declared. + north + Sets the maximum latitude of the map (in degrees North) + if `east`, `west` and `south` are declared. + south + Sets the minimum latitude of the map (in degrees North) + if `east`, `west` and `north` are declared. + west + Sets the minimum longitude of the map (in degrees East) + if `east`, `south` and `north` are declared. + + Returns + ------- + Bounds + """ + super().__init__("bounds") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.Bounds +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.Bounds`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("east", arg, east) + self._set_property("north", arg, north) + self._set_property("south", arg, south) + self._set_property("west", arg, west) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_center.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_center.py new file mode 100644 index 0000000..34c339e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_center.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map" + _path_str = "layout.map.center" + _valid_props = {"lat", "lon"} + + @property + def lat(self): + """ + Sets the latitude of the center of the map (in degrees North). + + The 'lat' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def lon(self): + """ + Sets the longitude of the center of the map (in degrees East). + + The 'lon' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def _prop_descriptions(self): + return """\ + lat + Sets the latitude of the center of the map (in degrees + North). + lon + Sets the longitude of the center of the map (in degrees + East). + """ + + def __init__(self, arg=None, lat=None, lon=None, **kwargs): + """ + Construct a new Center object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.Center` + lat + Sets the latitude of the center of the map (in degrees + North). + lon + Sets the longitude of the center of the map (in degrees + East). + + Returns + ------- + Center + """ + super().__init__("center") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.Center +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.Center`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("lat", arg, lat) + self._set_property("lon", arg, lon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_domain.py new file mode 100644 index 0000000..9baf6ea --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map" + _path_str = "layout.map.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this map subplot . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this map subplot . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this map subplot (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this map subplot (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this map subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this map subplot . + x + Sets the horizontal domain of this map subplot (in plot + fraction). + y + Sets the vertical domain of this map subplot (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this map subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this map subplot . + x + Sets the horizontal domain of this map subplot (in plot + fraction). + y + Sets the vertical domain of this map subplot (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_layer.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_layer.py new file mode 100644 index 0000000..cf22d32 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/_layer.py @@ -0,0 +1,691 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Layer(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map" + _path_str = "layout.map.layer" + _valid_props = { + "below", + "circle", + "color", + "coordinates", + "fill", + "line", + "maxzoom", + "minzoom", + "name", + "opacity", + "source", + "sourceattribution", + "sourcelayer", + "sourcetype", + "symbol", + "templateitemname", + "type", + "visible", + } + + @property + def below(self): + """ + Determines if the layer will be inserted before the layer with + the specified ID. If omitted or set to '', the layer will be + inserted above every existing layer. + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def circle(self): + """ + The 'circle' property is an instance of Circle + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.layer.Circle` + - A dict of string/value properties that will be passed + to the Circle constructor + + Returns + ------- + plotly.graph_objs.layout.map.layer.Circle + """ + return self["circle"] + + @circle.setter + def circle(self, val): + self["circle"] = val + + @property + def color(self): + """ + Sets the primary layer color. If `type` is "circle", color + corresponds to the circle color (map.layer.paint.circle-color) + If `type` is "line", color corresponds to the line color + (map.layer.paint.line-color) If `type` is "fill", color + corresponds to the fill color (map.layer.paint.fill-color) If + `type` is "symbol", color corresponds to the icon color + (map.layer.paint.icon-color) + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coordinates(self): + """ + Sets the coordinates array contains [longitude, latitude] pairs + for the image corners listed in clockwise order: top left, top + right, bottom right, bottom left. Only has an effect for + "image" `sourcetype`. + + The 'coordinates' property accepts values of any type + + Returns + ------- + Any + """ + return self["coordinates"] + + @coordinates.setter + def coordinates(self, val): + self["coordinates"] = val + + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.layer.Fill` + - A dict of string/value properties that will be passed + to the Fill constructor + + Returns + ------- + plotly.graph_objs.layout.map.layer.Fill + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.layer.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.layout.map.layer.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxzoom(self): + """ + Sets the maximum zoom level (map.layer.maxzoom). At zoom levels + equal to or greater than the maxzoom, the layer will be hidden. + + The 'maxzoom' property is a number and may be specified as: + - An int or float in the interval [0, 24] + + Returns + ------- + int|float + """ + return self["maxzoom"] + + @maxzoom.setter + def maxzoom(self, val): + self["maxzoom"] = val + + @property + def minzoom(self): + """ + Sets the minimum zoom level (map.layer.minzoom). At zoom levels + less than the minzoom, the layer will be hidden. + + The 'minzoom' property is a number and may be specified as: + - An int or float in the interval [0, 24] + + Returns + ------- + int|float + """ + return self["minzoom"] + + @minzoom.setter + def minzoom(self, val): + self["minzoom"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the layer. If `type` is "circle", opacity + corresponds to the circle opacity (map.layer.paint.circle- + opacity) If `type` is "line", opacity corresponds to the line + opacity (map.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity (map.layer.paint.fill- + opacity) If `type` is "symbol", opacity corresponds to the + icon/text opacity (map.layer.paint.text-opacity) + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def source(self): + """ + Sets the source data for this layer (map.layer.source). When + `sourcetype` is set to "geojson", `source` can be a URL to a + GeoJSON or a GeoJSON object. When `sourcetype` is set to + "vector" or "raster", `source` can be a URL or an array of tile + URLs. When `sourcetype` is set to "image", `source` can be a + URL to an image. + + The 'source' property accepts values of any type + + Returns + ------- + Any + """ + return self["source"] + + @source.setter + def source(self, val): + self["source"] = val + + @property + def sourceattribution(self): + """ + Sets the attribution for this source. + + The 'sourceattribution' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["sourceattribution"] + + @sourceattribution.setter + def sourceattribution(self, val): + self["sourceattribution"] = val + + @property + def sourcelayer(self): + """ + Specifies the layer to use from a vector tile source + (map.layer.source-layer). Required for "vector" source type + that supports multiple layers. + + The 'sourcelayer' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["sourcelayer"] + + @sourcelayer.setter + def sourcelayer(self, val): + self["sourcelayer"] = val + + @property + def sourcetype(self): + """ + Sets the source type for this layer, that is the type of the + layer data. + + The 'sourcetype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['geojson', 'vector', 'raster', 'image'] + + Returns + ------- + Any + """ + return self["sourcetype"] + + @sourcetype.setter + def sourcetype(self, val): + self["sourcetype"] = val + + @property + def symbol(self): + """ + The 'symbol' property is an instance of Symbol + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.layer.Symbol` + - A dict of string/value properties that will be passed + to the Symbol constructor + + Returns + ------- + plotly.graph_objs.layout.map.layer.Symbol + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def type(self): + """ + Sets the layer type, that is the how the layer data set in + `source` will be rendered With `sourcetype` set to "geojson", + the following values are allowed: "circle", "line", "fill" and + "symbol". but note that "line" and "fill" are not compatible + with Point GeoJSON geometries. With `sourcetype` set to + "vector", the following values are allowed: "circle", "line", + "fill" and "symbol". With `sourcetype` set to "raster" or + `*image*`, only the "raster" value is allowed. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circle', 'line', 'fill', 'symbol', 'raster'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + Determines whether this layer is displayed + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + below + Determines if the layer will be inserted before the + layer with the specified ID. If omitted or set to '', + the layer will be inserted above every existing layer. + circle + :class:`plotly.graph_objects.layout.map.layer.Circle` + instance or dict with compatible properties + color + Sets the primary layer color. If `type` is "circle", + color corresponds to the circle color + (map.layer.paint.circle-color) If `type` is "line", + color corresponds to the line color + (map.layer.paint.line-color) If `type` is "fill", color + corresponds to the fill color (map.layer.paint.fill- + color) If `type` is "symbol", color corresponds to the + icon color (map.layer.paint.icon-color) + coordinates + Sets the coordinates array contains [longitude, + latitude] pairs for the image corners listed in + clockwise order: top left, top right, bottom right, + bottom left. Only has an effect for "image" + `sourcetype`. + fill + :class:`plotly.graph_objects.layout.map.layer.Fill` + instance or dict with compatible properties + line + :class:`plotly.graph_objects.layout.map.layer.Line` + instance or dict with compatible properties + maxzoom + Sets the maximum zoom level (map.layer.maxzoom). At + zoom levels equal to or greater than the maxzoom, the + layer will be hidden. + minzoom + Sets the minimum zoom level (map.layer.minzoom). At + zoom levels less than the minzoom, the layer will be + hidden. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the layer. If `type` is "circle", + opacity corresponds to the circle opacity + (map.layer.paint.circle-opacity) If `type` is "line", + opacity corresponds to the line opacity + (map.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (map.layer.paint.fill-opacity) If `type` is "symbol", + opacity corresponds to the icon/text opacity + (map.layer.paint.text-opacity) + source + Sets the source data for this layer (map.layer.source). + When `sourcetype` is set to "geojson", `source` can be + a URL to a GeoJSON or a GeoJSON object. When + `sourcetype` is set to "vector" or "raster", `source` + can be a URL or an array of tile URLs. When + `sourcetype` is set to "image", `source` can be a URL + to an image. + sourceattribution + Sets the attribution for this source. + sourcelayer + Specifies the layer to use from a vector tile source + (map.layer.source-layer). Required for "vector" source + type that supports multiple layers. + sourcetype + Sets the source type for this layer, that is the type + of the layer data. + symbol + :class:`plotly.graph_objects.layout.map.layer.Symbol` + instance or dict with compatible properties + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Sets the layer type, that is the how the layer data set + in `source` will be rendered With `sourcetype` set to + "geojson", the following values are allowed: "circle", + "line", "fill" and "symbol". but note that "line" and + "fill" are not compatible with Point GeoJSON + geometries. With `sourcetype` set to "vector", the + following values are allowed: "circle", "line", "fill" + and "symbol". With `sourcetype` set to "raster" or + `*image*`, only the "raster" value is allowed. + visible + Determines whether this layer is displayed + """ + + def __init__( + self, + arg=None, + below=None, + circle=None, + color=None, + coordinates=None, + fill=None, + line=None, + maxzoom=None, + minzoom=None, + name=None, + opacity=None, + source=None, + sourceattribution=None, + sourcelayer=None, + sourcetype=None, + symbol=None, + templateitemname=None, + type=None, + visible=None, + **kwargs, + ): + """ + Construct a new Layer object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.Layer` + below + Determines if the layer will be inserted before the + layer with the specified ID. If omitted or set to '', + the layer will be inserted above every existing layer. + circle + :class:`plotly.graph_objects.layout.map.layer.Circle` + instance or dict with compatible properties + color + Sets the primary layer color. If `type` is "circle", + color corresponds to the circle color + (map.layer.paint.circle-color) If `type` is "line", + color corresponds to the line color + (map.layer.paint.line-color) If `type` is "fill", color + corresponds to the fill color (map.layer.paint.fill- + color) If `type` is "symbol", color corresponds to the + icon color (map.layer.paint.icon-color) + coordinates + Sets the coordinates array contains [longitude, + latitude] pairs for the image corners listed in + clockwise order: top left, top right, bottom right, + bottom left. Only has an effect for "image" + `sourcetype`. + fill + :class:`plotly.graph_objects.layout.map.layer.Fill` + instance or dict with compatible properties + line + :class:`plotly.graph_objects.layout.map.layer.Line` + instance or dict with compatible properties + maxzoom + Sets the maximum zoom level (map.layer.maxzoom). At + zoom levels equal to or greater than the maxzoom, the + layer will be hidden. + minzoom + Sets the minimum zoom level (map.layer.minzoom). At + zoom levels less than the minzoom, the layer will be + hidden. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the layer. If `type` is "circle", + opacity corresponds to the circle opacity + (map.layer.paint.circle-opacity) If `type` is "line", + opacity corresponds to the line opacity + (map.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (map.layer.paint.fill-opacity) If `type` is "symbol", + opacity corresponds to the icon/text opacity + (map.layer.paint.text-opacity) + source + Sets the source data for this layer (map.layer.source). + When `sourcetype` is set to "geojson", `source` can be + a URL to a GeoJSON or a GeoJSON object. When + `sourcetype` is set to "vector" or "raster", `source` + can be a URL or an array of tile URLs. When + `sourcetype` is set to "image", `source` can be a URL + to an image. + sourceattribution + Sets the attribution for this source. + sourcelayer + Specifies the layer to use from a vector tile source + (map.layer.source-layer). Required for "vector" source + type that supports multiple layers. + sourcetype + Sets the source type for this layer, that is the type + of the layer data. + symbol + :class:`plotly.graph_objects.layout.map.layer.Symbol` + instance or dict with compatible properties + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Sets the layer type, that is the how the layer data set + in `source` will be rendered With `sourcetype` set to + "geojson", the following values are allowed: "circle", + "line", "fill" and "symbol". but note that "line" and + "fill" are not compatible with Point GeoJSON + geometries. With `sourcetype` set to "vector", the + following values are allowed: "circle", "line", "fill" + and "symbol". With `sourcetype` set to "raster" or + `*image*`, only the "raster" value is allowed. + visible + Determines whether this layer is displayed + + Returns + ------- + Layer + """ + super().__init__("layers") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.Layer +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.Layer`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("below", arg, below) + self._set_property("circle", arg, circle) + self._set_property("color", arg, color) + self._set_property("coordinates", arg, coordinates) + self._set_property("fill", arg, fill) + self._set_property("line", arg, line) + self._set_property("maxzoom", arg, maxzoom) + self._set_property("minzoom", arg, minzoom) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("source", arg, source) + self._set_property("sourceattribution", arg, sourceattribution) + self._set_property("sourcelayer", arg, sourcelayer) + self._set_property("sourcetype", arg, sourcetype) + self._set_property("symbol", arg, symbol) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/__init__.py new file mode 100644 index 0000000..2d86fbd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._circle import Circle + from ._fill import Fill + from ._line import Line + from ._symbol import Symbol + from . import symbol +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".symbol"], + ["._circle.Circle", "._fill.Fill", "._line.Line", "._symbol.Symbol"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_circle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_circle.py new file mode 100644 index 0000000..2d99a00 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_circle.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Circle(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map.layer" + _path_str = "layout.map.layer.circle" + _valid_props = {"radius"} + + @property + def radius(self): + """ + Sets the circle radius (map.layer.paint.circle-radius). Has an + effect only when `type` is set to "circle". + + The 'radius' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["radius"] + + @radius.setter + def radius(self, val): + self["radius"] = val + + @property + def _prop_descriptions(self): + return """\ + radius + Sets the circle radius (map.layer.paint.circle-radius). + Has an effect only when `type` is set to "circle". + """ + + def __init__(self, arg=None, radius=None, **kwargs): + """ + Construct a new Circle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.layer.Circle` + radius + Sets the circle radius (map.layer.paint.circle-radius). + Has an effect only when `type` is set to "circle". + + Returns + ------- + Circle + """ + super().__init__("circle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.layer.Circle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.layer.Circle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("radius", arg, radius) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_fill.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_fill.py new file mode 100644 index 0000000..2c82cdd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_fill.py @@ -0,0 +1,86 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Fill(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map.layer" + _path_str = "layout.map.layer.fill" + _valid_props = {"outlinecolor"} + + @property + def outlinecolor(self): + """ + Sets the fill outline color (map.layer.paint.fill-outline- + color). Has an effect only when `type` is set to "fill". + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def _prop_descriptions(self): + return """\ + outlinecolor + Sets the fill outline color (map.layer.paint.fill- + outline-color). Has an effect only when `type` is set + to "fill". + """ + + def __init__(self, arg=None, outlinecolor=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.layer.Fill` + outlinecolor + Sets the fill outline color (map.layer.paint.fill- + outline-color). Has an effect only when `type` is set + to "fill". + + Returns + ------- + Fill + """ + super().__init__("fill") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.layer.Fill +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.layer.Fill`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("outlinecolor", arg, outlinecolor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_line.py new file mode 100644 index 0000000..369be5f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_line.py @@ -0,0 +1,133 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map.layer" + _path_str = "layout.map.layer.line" + _valid_props = {"dash", "dashsrc", "width"} + + @property + def dash(self): + """ + Sets the length of dashes and gaps (map.layer.paint.line- + dasharray). Has an effect only when `type` is set to "line". + + The 'dash' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def dashsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `dash`. + + The 'dashsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["dashsrc"] + + @dashsrc.setter + def dashsrc(self, val): + self["dashsrc"] = val + + @property + def width(self): + """ + Sets the line width (map.layer.paint.line-width). Has an effect + only when `type` is set to "line". + + The 'width' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + dash + Sets the length of dashes and gaps + (map.layer.paint.line-dasharray). Has an effect only + when `type` is set to "line". + dashsrc + Sets the source reference on Chart Studio Cloud for + `dash`. + width + Sets the line width (map.layer.paint.line-width). Has + an effect only when `type` is set to "line". + """ + + def __init__(self, arg=None, dash=None, dashsrc=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.layer.Line` + dash + Sets the length of dashes and gaps + (map.layer.paint.line-dasharray). Has an effect only + when `type` is set to "line". + dashsrc + Sets the source reference on Chart Studio Cloud for + `dash`. + width + Sets the line width (map.layer.paint.line-width). Has + an effect only when `type` is set to "line". + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.layer.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.layer.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dash", arg, dash) + self._set_property("dashsrc", arg, dashsrc) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_symbol.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_symbol.py new file mode 100644 index 0000000..58507ae --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/_symbol.py @@ -0,0 +1,243 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Symbol(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map.layer" + _path_str = "layout.map.layer.symbol" + _valid_props = {"icon", "iconsize", "placement", "text", "textfont", "textposition"} + + @property + def icon(self): + """ + Sets the symbol icon image (map.layer.layout.icon-image). Full + list: https://www.map.com/maki-icons/ + + The 'icon' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["icon"] + + @icon.setter + def icon(self, val): + self["icon"] = val + + @property + def iconsize(self): + """ + Sets the symbol icon size (map.layer.layout.icon-size). Has an + effect only when `type` is set to "symbol". + + The 'iconsize' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["iconsize"] + + @iconsize.setter + def iconsize(self, val): + self["iconsize"] = val + + @property + def placement(self): + """ + Sets the symbol and/or text placement (map.layer.layout.symbol- + placement). If `placement` is "point", the label is placed + where the geometry is located If `placement` is "line", the + label is placed along the line of the geometry If `placement` + is "line-center", the label is placed on the center of the + geometry + + The 'placement' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['point', 'line', 'line-center'] + + Returns + ------- + Any + """ + return self["placement"] + + @placement.setter + def placement(self, val): + self["placement"] = val + + @property + def text(self): + """ + Sets the symbol text (map.layer.layout.text-field). + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the icon text font (color=map.layer.paint.text-color, + size=map.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.map.layer.symbol.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.layout.map.layer.symbol.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def _prop_descriptions(self): + return """\ + icon + Sets the symbol icon image (map.layer.layout.icon- + image). Full list: https://www.map.com/maki-icons/ + iconsize + Sets the symbol icon size (map.layer.layout.icon-size). + Has an effect only when `type` is set to "symbol". + placement + Sets the symbol and/or text placement + (map.layer.layout.symbol-placement). If `placement` is + "point", the label is placed where the geometry is + located If `placement` is "line", the label is placed + along the line of the geometry If `placement` is "line- + center", the label is placed on the center of the + geometry + text + Sets the symbol text (map.layer.layout.text-field). + textfont + Sets the icon text font (color=map.layer.paint.text- + color, size=map.layer.layout.text-size). Has an effect + only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + """ + + def __init__( + self, + arg=None, + icon=None, + iconsize=None, + placement=None, + text=None, + textfont=None, + textposition=None, + **kwargs, + ): + """ + Construct a new Symbol object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.map.layer.Symbol` + icon + Sets the symbol icon image (map.layer.layout.icon- + image). Full list: https://www.map.com/maki-icons/ + iconsize + Sets the symbol icon size (map.layer.layout.icon-size). + Has an effect only when `type` is set to "symbol". + placement + Sets the symbol and/or text placement + (map.layer.layout.symbol-placement). If `placement` is + "point", the label is placed where the geometry is + located If `placement` is "line", the label is placed + along the line of the geometry If `placement` is "line- + center", the label is placed on the center of the + geometry + text + Sets the symbol text (map.layer.layout.text-field). + textfont + Sets the icon text font (color=map.layer.paint.text- + color, size=map.layer.layout.text-size). Has an effect + only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + + Returns + ------- + Symbol + """ + super().__init__("symbol") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.layer.Symbol +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.layer.Symbol`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("icon", arg, icon) + self._set_property("iconsize", arg, iconsize) + self._set_property("placement", arg, placement) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/__init__.py new file mode 100644 index 0000000..a713099 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/_textfont.py new file mode 100644 index 0000000..911cbcd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/map/layer/symbol/_textfont.py @@ -0,0 +1,202 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Textfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.map.layer.symbol" + _path_str = "layout.map.layer.symbol.textfont" + _valid_props = {"color", "family", "size", "style", "weight"} + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + size=None, + style=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the icon text font (color=map.layer.paint.text-color, + size=map.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.map.lay + er.symbol.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.map.layer.symbol.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.map.layer.symbol.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/__init__.py new file mode 100644 index 0000000..929c41c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._bounds import Bounds + from ._center import Center + from ._domain import Domain + from ._layer import Layer + from . import layer +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".layer"], + ["._bounds.Bounds", "._center.Center", "._domain.Domain", "._layer.Layer"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_bounds.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_bounds.py new file mode 100644 index 0000000..0179224 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_bounds.py @@ -0,0 +1,160 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Bounds(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox" + _path_str = "layout.mapbox.bounds" + _valid_props = {"east", "north", "south", "west"} + + @property + def east(self): + """ + Sets the maximum longitude of the map (in degrees East) if + `west`, `south` and `north` are declared. + + The 'east' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["east"] + + @east.setter + def east(self, val): + self["east"] = val + + @property + def north(self): + """ + Sets the maximum latitude of the map (in degrees North) if + `east`, `west` and `south` are declared. + + The 'north' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["north"] + + @north.setter + def north(self, val): + self["north"] = val + + @property + def south(self): + """ + Sets the minimum latitude of the map (in degrees North) if + `east`, `west` and `north` are declared. + + The 'south' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["south"] + + @south.setter + def south(self, val): + self["south"] = val + + @property + def west(self): + """ + Sets the minimum longitude of the map (in degrees East) if + `east`, `south` and `north` are declared. + + The 'west' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["west"] + + @west.setter + def west(self, val): + self["west"] = val + + @property + def _prop_descriptions(self): + return """\ + east + Sets the maximum longitude of the map (in degrees East) + if `west`, `south` and `north` are declared. + north + Sets the maximum latitude of the map (in degrees North) + if `east`, `west` and `south` are declared. + south + Sets the minimum latitude of the map (in degrees North) + if `east`, `west` and `north` are declared. + west + Sets the minimum longitude of the map (in degrees East) + if `east`, `south` and `north` are declared. + """ + + def __init__( + self, arg=None, east=None, north=None, south=None, west=None, **kwargs + ): + """ + Construct a new Bounds object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.Bounds` + east + Sets the maximum longitude of the map (in degrees East) + if `west`, `south` and `north` are declared. + north + Sets the maximum latitude of the map (in degrees North) + if `east`, `west` and `south` are declared. + south + Sets the minimum latitude of the map (in degrees North) + if `east`, `west` and `north` are declared. + west + Sets the minimum longitude of the map (in degrees East) + if `east`, `south` and `north` are declared. + + Returns + ------- + Bounds + """ + super().__init__("bounds") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.Bounds +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.Bounds`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("east", arg, east) + self._set_property("north", arg, north) + self._set_property("south", arg, south) + self._set_property("west", arg, west) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_center.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_center.py new file mode 100644 index 0000000..c3a2380 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_center.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox" + _path_str = "layout.mapbox.center" + _valid_props = {"lat", "lon"} + + @property + def lat(self): + """ + Sets the latitude of the center of the map (in degrees North). + + The 'lat' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lat"] + + @lat.setter + def lat(self, val): + self["lat"] = val + + @property + def lon(self): + """ + Sets the longitude of the center of the map (in degrees East). + + The 'lon' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["lon"] + + @lon.setter + def lon(self, val): + self["lon"] = val + + @property + def _prop_descriptions(self): + return """\ + lat + Sets the latitude of the center of the map (in degrees + North). + lon + Sets the longitude of the center of the map (in degrees + East). + """ + + def __init__(self, arg=None, lat=None, lon=None, **kwargs): + """ + Construct a new Center object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.Center` + lat + Sets the latitude of the center of the map (in degrees + North). + lon + Sets the longitude of the center of the map (in degrees + East). + + Returns + ------- + Center + """ + super().__init__("center") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.Center +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.Center`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("lat", arg, lat) + self._set_property("lon", arg, lon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_domain.py new file mode 100644 index 0000000..371af69 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox" + _path_str = "layout.mapbox.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this mapbox subplot . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this mapbox subplot . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this mapbox subplot (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this mapbox subplot (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this mapbox subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this mapbox subplot . + x + Sets the horizontal domain of this mapbox subplot (in + plot fraction). + y + Sets the vertical domain of this mapbox subplot (in + plot fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this mapbox subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this mapbox subplot . + x + Sets the horizontal domain of this mapbox subplot (in + plot fraction). + y + Sets the vertical domain of this mapbox subplot (in + plot fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_layer.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_layer.py new file mode 100644 index 0000000..abad68f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/_layer.py @@ -0,0 +1,695 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Layer(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox" + _path_str = "layout.mapbox.layer" + _valid_props = { + "below", + "circle", + "color", + "coordinates", + "fill", + "line", + "maxzoom", + "minzoom", + "name", + "opacity", + "source", + "sourceattribution", + "sourcelayer", + "sourcetype", + "symbol", + "templateitemname", + "type", + "visible", + } + + @property + def below(self): + """ + Determines if the layer will be inserted before the layer with + the specified ID. If omitted or set to '', the layer will be + inserted above every existing layer. + + The 'below' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["below"] + + @below.setter + def below(self, val): + self["below"] = val + + @property + def circle(self): + """ + The 'circle' property is an instance of Circle + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Circle` + - A dict of string/value properties that will be passed + to the Circle constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Circle + """ + return self["circle"] + + @circle.setter + def circle(self, val): + self["circle"] = val + + @property + def color(self): + """ + Sets the primary layer color. If `type` is "circle", color + corresponds to the circle color (mapbox.layer.paint.circle- + color) If `type` is "line", color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is "fill", color + corresponds to the fill color (mapbox.layer.paint.fill-color) + If `type` is "symbol", color corresponds to the icon color + (mapbox.layer.paint.icon-color) + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coordinates(self): + """ + Sets the coordinates array contains [longitude, latitude] pairs + for the image corners listed in clockwise order: top left, top + right, bottom right, bottom left. Only has an effect for + "image" `sourcetype`. + + The 'coordinates' property accepts values of any type + + Returns + ------- + Any + """ + return self["coordinates"] + + @coordinates.setter + def coordinates(self, val): + self["coordinates"] = val + + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Fill` + - A dict of string/value properties that will be passed + to the Fill constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Fill + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxzoom(self): + """ + Sets the maximum zoom level (mapbox.layer.maxzoom). At zoom + levels equal to or greater than the maxzoom, the layer will be + hidden. + + The 'maxzoom' property is a number and may be specified as: + - An int or float in the interval [0, 24] + + Returns + ------- + int|float + """ + return self["maxzoom"] + + @maxzoom.setter + def maxzoom(self, val): + self["maxzoom"] = val + + @property + def minzoom(self): + """ + Sets the minimum zoom level (mapbox.layer.minzoom). At zoom + levels less than the minzoom, the layer will be hidden. + + The 'minzoom' property is a number and may be specified as: + - An int or float in the interval [0, 24] + + Returns + ------- + int|float + """ + return self["minzoom"] + + @minzoom.setter + def minzoom(self, val): + self["minzoom"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the layer. If `type` is "circle", opacity + corresponds to the circle opacity (mapbox.layer.paint.circle- + opacity) If `type` is "line", opacity corresponds to the line + opacity (mapbox.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (mapbox.layer.paint.fill-opacity) If `type` is "symbol", + opacity corresponds to the icon/text opacity + (mapbox.layer.paint.text-opacity) + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def source(self): + """ + Sets the source data for this layer (mapbox.layer.source). When + `sourcetype` is set to "geojson", `source` can be a URL to a + GeoJSON or a GeoJSON object. When `sourcetype` is set to + "vector" or "raster", `source` can be a URL or an array of tile + URLs. When `sourcetype` is set to "image", `source` can be a + URL to an image. + + The 'source' property accepts values of any type + + Returns + ------- + Any + """ + return self["source"] + + @source.setter + def source(self, val): + self["source"] = val + + @property + def sourceattribution(self): + """ + Sets the attribution for this source. + + The 'sourceattribution' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["sourceattribution"] + + @sourceattribution.setter + def sourceattribution(self, val): + self["sourceattribution"] = val + + @property + def sourcelayer(self): + """ + Specifies the layer to use from a vector tile source + (mapbox.layer.source-layer). Required for "vector" source type + that supports multiple layers. + + The 'sourcelayer' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["sourcelayer"] + + @sourcelayer.setter + def sourcelayer(self, val): + self["sourcelayer"] = val + + @property + def sourcetype(self): + """ + Sets the source type for this layer, that is the type of the + layer data. + + The 'sourcetype' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['geojson', 'vector', 'raster', 'image'] + + Returns + ------- + Any + """ + return self["sourcetype"] + + @sourcetype.setter + def sourcetype(self, val): + self["sourcetype"] = val + + @property + def symbol(self): + """ + The 'symbol' property is an instance of Symbol + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.Symbol` + - A dict of string/value properties that will be passed + to the Symbol constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.Symbol + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def type(self): + """ + Sets the layer type, that is the how the layer data set in + `source` will be rendered With `sourcetype` set to "geojson", + the following values are allowed: "circle", "line", "fill" and + "symbol". but note that "line" and "fill" are not compatible + with Point GeoJSON geometries. With `sourcetype` set to + "vector", the following values are allowed: "circle", "line", + "fill" and "symbol". With `sourcetype` set to "raster" or + `*image*`, only the "raster" value is allowed. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circle', 'line', 'fill', 'symbol', 'raster'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + Determines whether this layer is displayed + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + below + Determines if the layer will be inserted before the + layer with the specified ID. If omitted or set to '', + the layer will be inserted above every existing layer. + circle + :class:`plotly.graph_objects.layout.mapbox.layer.Circle + ` instance or dict with compatible properties + color + Sets the primary layer color. If `type` is "circle", + color corresponds to the circle color + (mapbox.layer.paint.circle-color) If `type` is "line", + color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is "fill", + color corresponds to the fill color + (mapbox.layer.paint.fill-color) If `type` is "symbol", + color corresponds to the icon color + (mapbox.layer.paint.icon-color) + coordinates + Sets the coordinates array contains [longitude, + latitude] pairs for the image corners listed in + clockwise order: top left, top right, bottom right, + bottom left. Only has an effect for "image" + `sourcetype`. + fill + :class:`plotly.graph_objects.layout.mapbox.layer.Fill` + instance or dict with compatible properties + line + :class:`plotly.graph_objects.layout.mapbox.layer.Line` + instance or dict with compatible properties + maxzoom + Sets the maximum zoom level (mapbox.layer.maxzoom). At + zoom levels equal to or greater than the maxzoom, the + layer will be hidden. + minzoom + Sets the minimum zoom level (mapbox.layer.minzoom). At + zoom levels less than the minzoom, the layer will be + hidden. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the layer. If `type` is "circle", + opacity corresponds to the circle opacity + (mapbox.layer.paint.circle-opacity) If `type` is + "line", opacity corresponds to the line opacity + (mapbox.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (mapbox.layer.paint.fill-opacity) If `type` is + "symbol", opacity corresponds to the icon/text opacity + (mapbox.layer.paint.text-opacity) + source + Sets the source data for this layer + (mapbox.layer.source). When `sourcetype` is set to + "geojson", `source` can be a URL to a GeoJSON or a + GeoJSON object. When `sourcetype` is set to "vector" or + "raster", `source` can be a URL or an array of tile + URLs. When `sourcetype` is set to "image", `source` can + be a URL to an image. + sourceattribution + Sets the attribution for this source. + sourcelayer + Specifies the layer to use from a vector tile source + (mapbox.layer.source-layer). Required for "vector" + source type that supports multiple layers. + sourcetype + Sets the source type for this layer, that is the type + of the layer data. + symbol + :class:`plotly.graph_objects.layout.mapbox.layer.Symbol + ` instance or dict with compatible properties + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Sets the layer type, that is the how the layer data set + in `source` will be rendered With `sourcetype` set to + "geojson", the following values are allowed: "circle", + "line", "fill" and "symbol". but note that "line" and + "fill" are not compatible with Point GeoJSON + geometries. With `sourcetype` set to "vector", the + following values are allowed: "circle", "line", "fill" + and "symbol". With `sourcetype` set to "raster" or + `*image*`, only the "raster" value is allowed. + visible + Determines whether this layer is displayed + """ + + def __init__( + self, + arg=None, + below=None, + circle=None, + color=None, + coordinates=None, + fill=None, + line=None, + maxzoom=None, + minzoom=None, + name=None, + opacity=None, + source=None, + sourceattribution=None, + sourcelayer=None, + sourcetype=None, + symbol=None, + templateitemname=None, + type=None, + visible=None, + **kwargs, + ): + """ + Construct a new Layer object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.Layer` + below + Determines if the layer will be inserted before the + layer with the specified ID. If omitted or set to '', + the layer will be inserted above every existing layer. + circle + :class:`plotly.graph_objects.layout.mapbox.layer.Circle + ` instance or dict with compatible properties + color + Sets the primary layer color. If `type` is "circle", + color corresponds to the circle color + (mapbox.layer.paint.circle-color) If `type` is "line", + color corresponds to the line color + (mapbox.layer.paint.line-color) If `type` is "fill", + color corresponds to the fill color + (mapbox.layer.paint.fill-color) If `type` is "symbol", + color corresponds to the icon color + (mapbox.layer.paint.icon-color) + coordinates + Sets the coordinates array contains [longitude, + latitude] pairs for the image corners listed in + clockwise order: top left, top right, bottom right, + bottom left. Only has an effect for "image" + `sourcetype`. + fill + :class:`plotly.graph_objects.layout.mapbox.layer.Fill` + instance or dict with compatible properties + line + :class:`plotly.graph_objects.layout.mapbox.layer.Line` + instance or dict with compatible properties + maxzoom + Sets the maximum zoom level (mapbox.layer.maxzoom). At + zoom levels equal to or greater than the maxzoom, the + layer will be hidden. + minzoom + Sets the minimum zoom level (mapbox.layer.minzoom). At + zoom levels less than the minzoom, the layer will be + hidden. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the layer. If `type` is "circle", + opacity corresponds to the circle opacity + (mapbox.layer.paint.circle-opacity) If `type` is + "line", opacity corresponds to the line opacity + (mapbox.layer.paint.line-opacity) If `type` is "fill", + opacity corresponds to the fill opacity + (mapbox.layer.paint.fill-opacity) If `type` is + "symbol", opacity corresponds to the icon/text opacity + (mapbox.layer.paint.text-opacity) + source + Sets the source data for this layer + (mapbox.layer.source). When `sourcetype` is set to + "geojson", `source` can be a URL to a GeoJSON or a + GeoJSON object. When `sourcetype` is set to "vector" or + "raster", `source` can be a URL or an array of tile + URLs. When `sourcetype` is set to "image", `source` can + be a URL to an image. + sourceattribution + Sets the attribution for this source. + sourcelayer + Specifies the layer to use from a vector tile source + (mapbox.layer.source-layer). Required for "vector" + source type that supports multiple layers. + sourcetype + Sets the source type for this layer, that is the type + of the layer data. + symbol + :class:`plotly.graph_objects.layout.mapbox.layer.Symbol + ` instance or dict with compatible properties + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + type + Sets the layer type, that is the how the layer data set + in `source` will be rendered With `sourcetype` set to + "geojson", the following values are allowed: "circle", + "line", "fill" and "symbol". but note that "line" and + "fill" are not compatible with Point GeoJSON + geometries. With `sourcetype` set to "vector", the + following values are allowed: "circle", "line", "fill" + and "symbol". With `sourcetype` set to "raster" or + `*image*`, only the "raster" value is allowed. + visible + Determines whether this layer is displayed + + Returns + ------- + Layer + """ + super().__init__("layers") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.Layer +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.Layer`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("below", arg, below) + self._set_property("circle", arg, circle) + self._set_property("color", arg, color) + self._set_property("coordinates", arg, coordinates) + self._set_property("fill", arg, fill) + self._set_property("line", arg, line) + self._set_property("maxzoom", arg, maxzoom) + self._set_property("minzoom", arg, minzoom) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("source", arg, source) + self._set_property("sourceattribution", arg, sourceattribution) + self._set_property("sourcelayer", arg, sourcelayer) + self._set_property("sourcetype", arg, sourcetype) + self._set_property("symbol", arg, symbol) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/__init__.py new file mode 100644 index 0000000..2d86fbd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._circle import Circle + from ._fill import Fill + from ._line import Line + from ._symbol import Symbol + from . import symbol +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".symbol"], + ["._circle.Circle", "._fill.Fill", "._line.Line", "._symbol.Symbol"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_circle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_circle.py new file mode 100644 index 0000000..74ba819 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_circle.py @@ -0,0 +1,82 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Circle(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox.layer" + _path_str = "layout.mapbox.layer.circle" + _valid_props = {"radius"} + + @property + def radius(self): + """ + Sets the circle radius (mapbox.layer.paint.circle-radius). Has + an effect only when `type` is set to "circle". + + The 'radius' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["radius"] + + @radius.setter + def radius(self, val): + self["radius"] = val + + @property + def _prop_descriptions(self): + return """\ + radius + Sets the circle radius (mapbox.layer.paint.circle- + radius). Has an effect only when `type` is set to + "circle". + """ + + def __init__(self, arg=None, radius=None, **kwargs): + """ + Construct a new Circle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.layer.Circle` + radius + Sets the circle radius (mapbox.layer.paint.circle- + radius). Has an effect only when `type` is set to + "circle". + + Returns + ------- + Circle + """ + super().__init__("circle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Circle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Circle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("radius", arg, radius) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_fill.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_fill.py new file mode 100644 index 0000000..d7ae63c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_fill.py @@ -0,0 +1,86 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Fill(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox.layer" + _path_str = "layout.mapbox.layer.fill" + _valid_props = {"outlinecolor"} + + @property + def outlinecolor(self): + """ + Sets the fill outline color (mapbox.layer.paint.fill-outline- + color). Has an effect only when `type` is set to "fill". + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def _prop_descriptions(self): + return """\ + outlinecolor + Sets the fill outline color (mapbox.layer.paint.fill- + outline-color). Has an effect only when `type` is set + to "fill". + """ + + def __init__(self, arg=None, outlinecolor=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.layer.Fill` + outlinecolor + Sets the fill outline color (mapbox.layer.paint.fill- + outline-color). Has an effect only when `type` is set + to "fill". + + Returns + ------- + Fill + """ + super().__init__("fill") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Fill +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Fill`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("outlinecolor", arg, outlinecolor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_line.py new file mode 100644 index 0000000..1ca3ca3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_line.py @@ -0,0 +1,133 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox.layer" + _path_str = "layout.mapbox.layer.line" + _valid_props = {"dash", "dashsrc", "width"} + + @property + def dash(self): + """ + Sets the length of dashes and gaps (mapbox.layer.paint.line- + dasharray). Has an effect only when `type` is set to "line". + + The 'dash' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def dashsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `dash`. + + The 'dashsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["dashsrc"] + + @dashsrc.setter + def dashsrc(self, val): + self["dashsrc"] = val + + @property + def width(self): + """ + Sets the line width (mapbox.layer.paint.line-width). Has an + effect only when `type` is set to "line". + + The 'width' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + dash + Sets the length of dashes and gaps + (mapbox.layer.paint.line-dasharray). Has an effect only + when `type` is set to "line". + dashsrc + Sets the source reference on Chart Studio Cloud for + `dash`. + width + Sets the line width (mapbox.layer.paint.line-width). + Has an effect only when `type` is set to "line". + """ + + def __init__(self, arg=None, dash=None, dashsrc=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.layer.Line` + dash + Sets the length of dashes and gaps + (mapbox.layer.paint.line-dasharray). Has an effect only + when `type` is set to "line". + dashsrc + Sets the source reference on Chart Studio Cloud for + `dash`. + width + Sets the line width (mapbox.layer.paint.line-width). + Has an effect only when `type` is set to "line". + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dash", arg, dash) + self._set_property("dashsrc", arg, dashsrc) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_symbol.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_symbol.py new file mode 100644 index 0000000..506e36a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/_symbol.py @@ -0,0 +1,245 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Symbol(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox.layer" + _path_str = "layout.mapbox.layer.symbol" + _valid_props = {"icon", "iconsize", "placement", "text", "textfont", "textposition"} + + @property + def icon(self): + """ + Sets the symbol icon image (mapbox.layer.layout.icon-image). + Full list: https://www.mapbox.com/maki-icons/ + + The 'icon' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["icon"] + + @icon.setter + def icon(self, val): + self["icon"] = val + + @property + def iconsize(self): + """ + Sets the symbol icon size (mapbox.layer.layout.icon-size). Has + an effect only when `type` is set to "symbol". + + The 'iconsize' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["iconsize"] + + @iconsize.setter + def iconsize(self, val): + self["iconsize"] = val + + @property + def placement(self): + """ + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If `placement` is + "point", the label is placed where the geometry is located If + `placement` is "line", the label is placed along the line of + the geometry If `placement` is "line-center", the label is + placed on the center of the geometry + + The 'placement' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['point', 'line', 'line-center'] + + Returns + ------- + Any + """ + return self["placement"] + + @placement.setter + def placement(self, val): + self["placement"] = val + + @property + def text(self): + """ + Sets the symbol text (mapbox.layer.layout.text-field). + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textfont(self): + """ + Sets the icon text font (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.mapbox.layer.symbol.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.layout.mapbox.layer.symbol.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def textposition(self): + """ + Sets the positions of the `text` elements with respects to the + (x,y) coordinates. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def _prop_descriptions(self): + return """\ + icon + Sets the symbol icon image (mapbox.layer.layout.icon- + image). Full list: https://www.mapbox.com/maki-icons/ + iconsize + Sets the symbol icon size (mapbox.layer.layout.icon- + size). Has an effect only when `type` is set to + "symbol". + placement + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If `placement` + is "point", the label is placed where the geometry is + located If `placement` is "line", the label is placed + along the line of the geometry If `placement` is "line- + center", the label is placed on the center of the + geometry + text + Sets the symbol text (mapbox.layer.layout.text-field). + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + """ + + def __init__( + self, + arg=None, + icon=None, + iconsize=None, + placement=None, + text=None, + textfont=None, + textposition=None, + **kwargs, + ): + """ + Construct a new Symbol object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.mapbox.layer.Symbol` + icon + Sets the symbol icon image (mapbox.layer.layout.icon- + image). Full list: https://www.mapbox.com/maki-icons/ + iconsize + Sets the symbol icon size (mapbox.layer.layout.icon- + size). Has an effect only when `type` is set to + "symbol". + placement + Sets the symbol and/or text placement + (mapbox.layer.layout.symbol-placement). If `placement` + is "point", the label is placed where the geometry is + located If `placement` is "line", the label is placed + along the line of the geometry If `placement` is "line- + center", the label is placed on the center of the + geometry + text + Sets the symbol text (mapbox.layer.layout.text-field). + textfont + Sets the icon text font (color=mapbox.layer.paint.text- + color, size=mapbox.layer.layout.text-size). Has an + effect only when `type` is set to "symbol". + textposition + Sets the positions of the `text` elements with respects + to the (x,y) coordinates. + + Returns + ------- + Symbol + """ + super().__init__("symbol") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.Symbol +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.Symbol`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("icon", arg, icon) + self._set_property("iconsize", arg, iconsize) + self._set_property("placement", arg, placement) + self._set_property("text", arg, text) + self._set_property("textfont", arg, textfont) + self._set_property("textposition", arg, textposition) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py new file mode 100644 index 0000000..a713099 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py new file mode 100644 index 0000000..473535e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/mapbox/layer/symbol/_textfont.py @@ -0,0 +1,202 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Textfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.mapbox.layer.symbol" + _path_str = "layout.mapbox.layer.symbol.textfont" + _valid_props = {"color", "family", "size", "style", "weight"} + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + size=None, + style=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the icon text font (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.mapbox. + layer.symbol.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.mapbox.layer.symbol.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.mapbox.layer.symbol.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/_line.py new file mode 100644 index 0000000..b7d6420 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newselection/_line.py @@ -0,0 +1,142 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + _parent_path_str = "layout.newselection" + _path_str = "layout.newselection.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. By default uses either dark grey or white + to increase contrast with background color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. By default uses either dark grey + or white to increase contrast with background color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.newselection.Line` + color + Sets the line color. By default uses either dark grey + or white to increase contrast with background color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.newselection.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.newselection.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/__init__.py new file mode 100644 index 0000000..9192b99 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._label import Label + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from . import label + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".label", ".legendgrouptitle"], + ["._label.Label", "._legendgrouptitle.Legendgrouptitle", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_label.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_label.py new file mode 100644 index 0000000..419a6a0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_label.py @@ -0,0 +1,397 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Label(_BaseLayoutHierarchyType): + _parent_path_str = "layout.newshape" + _path_str = "layout.newshape.label" + _valid_props = { + "font", + "padding", + "text", + "textangle", + "textposition", + "texttemplate", + "xanchor", + "yanchor", + } + + @property + def font(self): + """ + Sets the new shape label text font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.newshape.label.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.newshape.label.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def padding(self): + """ + Sets padding (in px) between edge of label and edge of new + shape. + + The 'padding' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["padding"] + + @padding.setter + def padding(self, val): + self["padding"] = val + + @property + def text(self): + """ + Sets the text to display with the new shape. It is also used + for legend item if `name` is not provided. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle at which the label text is drawn with respect to + the horizontal. For lines, angle "auto" is the same angle as + the line. For all other shapes, angle "auto" is horizontal. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def textposition(self): + """ + Sets the position of the label text relative to the new shape. + Supported values for rectangles, circles and paths are *top + left*, *top center*, *top right*, *middle left*, *middle + center*, *middle right*, *bottom left*, *bottom center*, and + *bottom right*. Supported values for lines are "start", + "middle", and "end". Default: *middle center* for rectangles, + circles, and paths; "middle" for lines. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right', 'start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the new shape's label. Note + that this will override `text`. Variables are inserted using + %{variable}, for example "x0: %{x0}". Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{x0:$.2f}". See + https://github.com/d3/d3-format/tree/v1.4.5#d3-format for + details on the formatting syntax. Dates are formatted using + d3-time-format's syntax %{variable|d3-time-format}, for example + "Day: %{x0|%m %b %Y}". See https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. A single multiplication or division + operation may be applied to numeric variables, and combined + with d3 number formatting, for example "Length in cm: + %{x0*2.54}", "%{slope*60:.1f} meters per second." For log axes, + variable values are given in log units. For date axes, x/y + coordinate variables and center variables use datetimes, while + all other variable values use values in ms. Finally, the + template string has access to variables `x0`, `x1`, `y0`, `y1`, + `slope`, `dx`, `dy`, `width`, `height`, `length`, `xcenter` and + `ycenter`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def xanchor(self): + """ + Sets the label's horizontal position anchor This anchor binds + the specified `textposition` to the "left", "center" or "right" + of the label text. For example, if `textposition` is set to + *top right* and `xanchor` to "right" then the right-most + portion of the label text lines up with the right-most edge of + the new shape. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def yanchor(self): + """ + Sets the label's vertical position anchor This anchor binds the + specified `textposition` to the "top", "middle" or "bottom" of + the label text. For example, if `textposition` is set to *top + right* and `yanchor` to "top" then the top-most portion of the + label text lines up with the top-most edge of the new shape. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets the new shape label text font. + padding + Sets padding (in px) between edge of label and edge of + new shape. + text + Sets the text to display with the new shape. It is also + used for legend item if `name` is not provided. + textangle + Sets the angle at which the label text is drawn with + respect to the horizontal. For lines, angle "auto" is + the same angle as the line. For all other shapes, angle + "auto" is horizontal. + textposition + Sets the position of the label text relative to the new + shape. Supported values for rectangles, circles and + paths are *top left*, *top center*, *top right*, + *middle left*, *middle center*, *middle right*, *bottom + left*, *bottom center*, and *bottom right*. Supported + values for lines are "start", "middle", and "end". + Default: *middle center* for rectangles, circles, and + paths; "middle" for lines. + texttemplate + Template string used for rendering the new shape's + label. Note that this will override `text`. Variables + are inserted using %{variable}, for example "x0: + %{x0}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{x0:$.2f}". + See + https://github.com/d3/d3-format/tree/v1.4.5#d3-format + for details on the formatting syntax. Dates are + formatted using d3-time-format's syntax + %{variable|d3-time-format}, for example "Day: %{x0|%m + %b %Y}". See https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. A single multiplication or + division operation may be applied to numeric variables, + and combined with d3 number formatting, for example + "Length in cm: %{x0*2.54}", "%{slope*60:.1f} meters per + second." For log axes, variable values are given in log + units. For date axes, x/y coordinate variables and + center variables use datetimes, while all other + variable values use values in ms. Finally, the template + string has access to variables `x0`, `x1`, `y0`, `y1`, + `slope`, `dx`, `dy`, `width`, `height`, `length`, + `xcenter` and `ycenter`. + xanchor + Sets the label's horizontal position anchor This anchor + binds the specified `textposition` to the "left", + "center" or "right" of the label text. For example, if + `textposition` is set to *top right* and `xanchor` to + "right" then the right-most portion of the label text + lines up with the right-most edge of the new shape. + yanchor + Sets the label's vertical position anchor This anchor + binds the specified `textposition` to the "top", + "middle" or "bottom" of the label text. For example, if + `textposition` is set to *top right* and `yanchor` to + "top" then the top-most portion of the label text lines + up with the top-most edge of the new shape. + """ + + def __init__( + self, + arg=None, + font=None, + padding=None, + text=None, + textangle=None, + textposition=None, + texttemplate=None, + xanchor=None, + yanchor=None, + **kwargs, + ): + """ + Construct a new Label object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.newshape.Label` + font + Sets the new shape label text font. + padding + Sets padding (in px) between edge of label and edge of + new shape. + text + Sets the text to display with the new shape. It is also + used for legend item if `name` is not provided. + textangle + Sets the angle at which the label text is drawn with + respect to the horizontal. For lines, angle "auto" is + the same angle as the line. For all other shapes, angle + "auto" is horizontal. + textposition + Sets the position of the label text relative to the new + shape. Supported values for rectangles, circles and + paths are *top left*, *top center*, *top right*, + *middle left*, *middle center*, *middle right*, *bottom + left*, *bottom center*, and *bottom right*. Supported + values for lines are "start", "middle", and "end". + Default: *middle center* for rectangles, circles, and + paths; "middle" for lines. + texttemplate + Template string used for rendering the new shape's + label. Note that this will override `text`. Variables + are inserted using %{variable}, for example "x0: + %{x0}". Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{x0:$.2f}". + See + https://github.com/d3/d3-format/tree/v1.4.5#d3-format + for details on the formatting syntax. Dates are + formatted using d3-time-format's syntax + %{variable|d3-time-format}, for example "Day: %{x0|%m + %b %Y}". See https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. A single multiplication or + division operation may be applied to numeric variables, + and combined with d3 number formatting, for example + "Length in cm: %{x0*2.54}", "%{slope*60:.1f} meters per + second." For log axes, variable values are given in log + units. For date axes, x/y coordinate variables and + center variables use datetimes, while all other + variable values use values in ms. Finally, the template + string has access to variables `x0`, `x1`, `y0`, `y1`, + `slope`, `dx`, `dy`, `width`, `height`, `length`, + `xcenter` and `ycenter`. + xanchor + Sets the label's horizontal position anchor This anchor + binds the specified `textposition` to the "left", + "center" or "right" of the label text. For example, if + `textposition` is set to *top right* and `xanchor` to + "right" then the right-most portion of the label text + lines up with the right-most edge of the new shape. + yanchor + Sets the label's vertical position anchor This anchor + binds the specified `textposition` to the "top", + "middle" or "bottom" of the label text. For example, if + `textposition` is set to *top right* and `yanchor` to + "top" then the top-most portion of the label text lines + up with the top-most edge of the new shape. + + Returns + ------- + Label + """ + super().__init__("label") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.newshape.Label +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.newshape.Label`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("padding", arg, padding) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("textposition", arg, textposition) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("xanchor", arg, xanchor) + self._set_property("yanchor", arg, yanchor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_legendgrouptitle.py new file mode 100644 index 0000000..00230ca --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseLayoutHierarchyType): + _parent_path_str = "layout.newshape" + _path_str = "layout.newshape.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.newshape.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.newshape.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.newshap + e.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.newshape.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.newshape.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_line.py new file mode 100644 index 0000000..9a679d8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/_line.py @@ -0,0 +1,142 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + _parent_path_str = "layout.newshape" + _path_str = "layout.newshape.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. By default uses either dark grey or white + to increase contrast with background color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. By default uses either dark grey + or white to increase contrast with background color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.newshape.Line` + color + Sets the line color. By default uses either dark grey + or white to increase contrast with background color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.newshape.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.newshape.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/_font.py new file mode 100644 index 0000000..91e49de --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/label/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.newshape.label" + _path_str = "layout.newshape.label.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the new shape label text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.newshape.label.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.newshape.label.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.newshape.label.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/_font.py new file mode 100644 index 0000000..879c619 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/newshape/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.newshape.legendgrouptitle" + _path_str = "layout.newshape.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.newshap + e.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.newshape.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.newshape.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/__init__.py new file mode 100644 index 0000000..b893a6c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._angularaxis import AngularAxis + from ._domain import Domain + from ._radialaxis import RadialAxis + from . import angularaxis + from . import radialaxis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".angularaxis", ".radialaxis"], + ["._angularaxis.AngularAxis", "._domain.Domain", "._radialaxis.RadialAxis"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_angularaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_angularaxis.py new file mode 100644 index 0000000..0dbf891 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_angularaxis.py @@ -0,0 +1,1776 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class AngularAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar" + _path_str = "layout.polar.angularaxis" + _valid_props = { + "autotypenumbers", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "direction", + "dtick", + "exponentformat", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "minexponent", + "nticks", + "period", + "rotation", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thetaunit", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "type", + "uirevision", + "visible", + } + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def direction(self): + """ + Sets the direction corresponding to positive angles. + + The 'direction' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['counterclockwise', 'clockwise'] + + Returns + ------- + Any + """ + return self["direction"] + + @direction.setter + def direction(self, val): + self["direction"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def period(self): + """ + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + + The 'period' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["period"] + + @period.setter + def period(self, val): + self["period"] = val + + @property + def rotation(self): + """ + Sets that start position (in degrees) of the angular axis By + default, polar subplots with `direction` set to + "counterclockwise" get a `rotation` of 0 which corresponds to + due East (like what mathematicians prefer). In turn, polar with + `direction` set to "clockwise" get a rotation of 90 which + corresponds to due North (like on a compass), + + The 'rotation' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["rotation"] + + @rotation.setter + def rotation(self, val): + self["rotation"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thetaunit(self): + """ + Sets the format unit of the formatted "theta" values. Has an + effect only when `angularaxis.type` is "linear". + + The 'thetaunit' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radians', 'degrees'] + + Returns + ------- + Any + """ + return self["thetaunit"] + + @thetaunit.setter + def thetaunit(self, val): + self["thetaunit"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.polar.angularaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.polar.angularaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.polar.angularaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.layout.polar.angula + raxis.tickformatstopdefaults), sets the default property values + to use for elements of layout.polar.angularaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.polar.angularaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def type(self): + """ + Sets the angular axis type. If "linear", set `thetaunit` to + determine the unit in which axis value are shown. If *category, + use `period` to set the number of integer coordinates around + polar axis. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `rotation`. + Defaults to `polar.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + direction + Sets the direction corresponding to positive angles. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + period + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + rotation + Sets that start position (in degrees) of the angular + axis By default, polar subplots with `direction` set to + "counterclockwise" get a `rotation` of 0 which + corresponds to due East (like what mathematicians + prefer). In turn, polar with `direction` set to + "clockwise" get a rotation of 90 which corresponds to + due North (like on a compass), + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thetaunit + Sets the format unit of the formatted "theta" values. + Has an effect only when `angularaxis.type` is "linear". + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.polar.an + gularaxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.angularaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.angularaxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + type + Sets the angular axis type. If "linear", set + `thetaunit` to determine the unit in which axis value + are shown. If *category, use `period` to set the number + of integer coordinates around polar axis. + uirevision + Controls persistence of user-driven changes in axis + `rotation`. Defaults to `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + def __init__( + self, + arg=None, + autotypenumbers=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + direction=None, + dtick=None, + exponentformat=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + minexponent=None, + nticks=None, + period=None, + rotation=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thetaunit=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + type=None, + uirevision=None, + visible=None, + **kwargs, + ): + """ + Construct a new AngularAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.polar.AngularAxis` + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + direction + Sets the direction corresponding to positive angles. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + period + Set the angular period. Has an effect only when + `angularaxis.type` is "category". + rotation + Sets that start position (in degrees) of the angular + axis By default, polar subplots with `direction` set to + "counterclockwise" get a `rotation` of 0 which + corresponds to due East (like what mathematicians + prefer). In turn, polar with `direction` set to + "clockwise" get a rotation of 90 which corresponds to + due North (like on a compass), + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thetaunit + Sets the format unit of the formatted "theta" values. + Has an effect only when `angularaxis.type` is "linear". + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.polar.an + gularaxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.angularaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.angularaxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + type + Sets the angular axis type. If "linear", set + `thetaunit` to determine the unit in which axis value + are shown. If *category, use `period` to set the number + of integer coordinates around polar axis. + uirevision + Controls persistence of user-driven changes in axis + `rotation`. Defaults to `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + AngularAxis + """ + super().__init__("angularaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.AngularAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.AngularAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("direction", arg, direction) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("period", arg, period) + self._set_property("rotation", arg, rotation) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thetaunit", arg, thetaunit) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("type", arg, type) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_domain.py new file mode 100644 index 0000000..0fd15cf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar" + _path_str = "layout.polar.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this polar subplot . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this polar subplot . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this polar subplot (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this polar subplot (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this polar subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this polar subplot . + x + Sets the horizontal domain of this polar subplot (in + plot fraction). + y + Sets the vertical domain of this polar subplot (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.polar.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this polar subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this polar subplot . + x + Sets the horizontal domain of this polar subplot (in + plot fraction). + y + Sets the vertical domain of this polar subplot (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_radialaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_radialaxis.py new file mode 100644 index 0000000..aa5bfd5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/_radialaxis.py @@ -0,0 +1,2049 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class RadialAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar" + _path_str = "layout.polar.radialaxis" + _valid_props = { + "angle", + "autorange", + "autorangeoptions", + "autotickangles", + "autotypenumbers", + "calendar", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "dtick", + "exponentformat", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "maxallowed", + "minallowed", + "minexponent", + "nticks", + "range", + "rangemode", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "side", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "type", + "uirevision", + "visible", + } + + @property + def angle(self): + """ + Sets the angle (in degrees) from which the radial axis is + drawn. Note that by default, radial axis line on the theta=0 + line corresponds to a line pointing right (like what + mathematicians prefer). Defaults to the first `polar.sector` + angle. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided and it has a value for both the lower and + upper bound, `autorange` is set to False. Using "min" applies + autorange only to set the minimum. Using "max" applies + autorange only to set the maximum. Using *min reversed* applies + autorange only to set the minimum on a reversed axis. Using + *max reversed* applies autorange only to set the maximum on a + reversed axis. Using "reversed" applies autorange on both ends + and reverses the axis direction. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autorangeoptions(self): + """ + The 'autorangeoptions' property is an instance of Autorangeoptions + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Autorangeoptions` + - A dict of string/value properties that will be passed + to the Autorangeoptions constructor + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.Autorangeoptions + """ + return self["autorangeoptions"] + + @autorangeoptions.setter + def autorangeoptions(self, val): + self["autorangeoptions"] = val + + @property + def autotickangles(self): + """ + When `tickangle` is set to "auto", it will be set to the first + angle in this array that is large enough to prevent label + overlap. + + The 'autotickangles' property is an info array that may be specified as: + * a list of elements where: + The 'autotickangles[i]' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + list + """ + return self["autotickangles"] + + @autotickangles.setter + def autotickangles(self, val): + self["autotickangles"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def maxallowed(self): + """ + Determines the maximum range of this axis. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Determines the minimum range of this axis. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + Leaving either or both elements `null` impacts the default + `autorange`. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + If "tozero", the range extends to 0, regardless of the input + data If "nonnegative", the range is non-negative, regardless of + the input data. If "normal", the range is computed in relation + to the extrema of the input data (same behavior as for + cartesian axes). + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['tozero', 'nonnegative', 'normal'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def side(self): + """ + Determines on which side of radial axis line the tick and tick + labels appear. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['clockwise', 'counterclockwise'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.polar.radialaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.polar.radialaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.layout.polar.radial + axis.tickformatstopdefaults), sets the default property values + to use for elements of layout.polar.radialaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'log', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `range`, + `autorange`, `angle`, and `title` if in `editable: true` + configuration. Defaults to `polar.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the angle (in degrees) from which the radial axis + is drawn. Note that by default, radial axis line on the + theta=0 line corresponds to a line pointing right (like + what mathematicians prefer). Defaults to the first + `polar.sector` angle. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.polar.radialaxis.Au + torangeoptions` instance or dict with compatible + properties + autotickangles + When `tickangle` is set to "auto", it will be set to + the first angle in this array that is large enough to + prevent label overlap. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "tozero", the range extends to 0, regardless of the + input data If "nonnegative", the range is non-negative, + regardless of the input data. If "normal", the range is + computed in relation to the extrema of the input data + (same behavior as for cartesian axes). + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of radial axis line the tick + and tick labels appear. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.polar.ra + dialaxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.radialaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.radialaxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.polar.radialaxis.Ti + tle` instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, `angle`, and `title` if in + `editable: true` configuration. Defaults to + `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + def __init__( + self, + arg=None, + angle=None, + autorange=None, + autorangeoptions=None, + autotickangles=None, + autotypenumbers=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + maxallowed=None, + minallowed=None, + minexponent=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + type=None, + uirevision=None, + visible=None, + **kwargs, + ): + """ + Construct a new RadialAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.polar.RadialAxis` + angle + Sets the angle (in degrees) from which the radial axis + is drawn. Note that by default, radial axis line on the + theta=0 line corresponds to a line pointing right (like + what mathematicians prefer). Defaults to the first + `polar.sector` angle. + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.polar.radialaxis.Au + torangeoptions` instance or dict with compatible + properties + autotickangles + When `tickangle` is set to "auto", it will be set to + the first angle in this array that is large enough to + prevent label overlap. + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "tozero", the range extends to 0, regardless of the + input data If "nonnegative", the range is non-negative, + regardless of the input data. If "normal", the range is + computed in relation to the extrema of the input data + (same behavior as for cartesian axes). + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of radial axis line the tick + and tick labels appear. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.polar.ra + dialaxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.pola + r.radialaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.polar.radialaxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.polar.radialaxis.Ti + tle` instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + uirevision + Controls persistence of user-driven changes in axis + `range`, `autorange`, `angle`, and `title` if in + `editable: true` configuration. Defaults to + `polar.uirevision`. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + RadialAxis + """ + super().__init__("radialaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.RadialAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.RadialAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("autorange", arg, autorange) + self._set_property("autorangeoptions", arg, autorangeoptions) + self._set_property("autotickangles", arg, autotickangles) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("calendar", arg, calendar) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("side", arg, side) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._set_property("uirevision", arg, uirevision) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/__init__.py new file mode 100644 index 0000000..1dfbe47 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py new file mode 100644 index 0000000..d0a6e74 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.angularaxis" + _path_str = "layout.polar.angularaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.a + ngularaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py new file mode 100644 index 0000000..8142b3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/angularaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.angularaxis" + _path_str = "layout.polar.angularaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.a + ngularaxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.angularaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.angularaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/__init__.py new file mode 100644 index 0000000..d58e980 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/__init__.py @@ -0,0 +1,22 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._autorangeoptions import Autorangeoptions + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + [ + "._autorangeoptions.Autorangeoptions", + "._tickfont.Tickfont", + "._tickformatstop.Tickformatstop", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_autorangeoptions.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_autorangeoptions.py new file mode 100644 index 0000000..0c12c55 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_autorangeoptions.py @@ -0,0 +1,216 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Autorangeoptions(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.radialaxis" + _path_str = "layout.polar.radialaxis.autorangeoptions" + _valid_props = { + "clipmax", + "clipmin", + "include", + "includesrc", + "maxallowed", + "minallowed", + } + + @property + def clipmax(self): + """ + Clip autorange maximum if it goes beyond this value. Has no + effect when `autorangeoptions.maxallowed` is provided. + + The 'clipmax' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmax"] + + @clipmax.setter + def clipmax(self, val): + self["clipmax"] = val + + @property + def clipmin(self): + """ + Clip autorange minimum if it goes beyond this value. Has no + effect when `autorangeoptions.minallowed` is provided. + + The 'clipmin' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmin"] + + @clipmin.setter + def clipmin(self, val): + self["clipmin"] = val + + @property + def include(self): + """ + Ensure this value is included in autorange. + + The 'include' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["include"] + + @include.setter + def include(self, val): + self["include"] = val + + @property + def includesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `include`. + + The 'includesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["includesrc"] + + @includesrc.setter + def includesrc(self, val): + self["includesrc"] = val + + @property + def maxallowed(self): + """ + Use this value exactly as autorange maximum. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Use this value exactly as autorange minimum. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def _prop_descriptions(self): + return """\ + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + """ + + def __init__( + self, + arg=None, + clipmax=None, + clipmin=None, + include=None, + includesrc=None, + maxallowed=None, + minallowed=None, + **kwargs, + ): + """ + Construct a new Autorangeoptions object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Autorangeoptions` + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + + Returns + ------- + Autorangeoptions + """ + super().__init__("autorangeoptions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Autorangeoptions +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Autorangeoptions`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("clipmax", arg, clipmax) + self._set_property("clipmin", arg, clipmin) + self._set_property("include", arg, include) + self._set_property("includesrc", arg, includesrc) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py new file mode 100644 index 0000000..6be3feb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.radialaxis" + _path_str = "layout.polar.radialaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py new file mode 100644 index 0000000..a2c237a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.radialaxis" + _path_str = "layout.polar.radialaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_title.py new file mode 100644 index 0000000..6472d88 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.radialaxis" + _path_str = "layout.polar.radialaxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.polar.radialaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.polar.radialaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/_font.py new file mode 100644 index 0000000..8a6981f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/polar/radialaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.polar.radialaxis.title" + _path_str = "layout.polar.radialaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.polar.r + adialaxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.polar.radialaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.polar.radialaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/__init__.py new file mode 100644 index 0000000..3b340bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/__init__.py @@ -0,0 +1,32 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._annotation import Annotation + from ._aspectratio import Aspectratio + from ._camera import Camera + from ._domain import Domain + from ._xaxis import XAxis + from ._yaxis import YAxis + from ._zaxis import ZAxis + from . import annotation + from . import camera + from . import xaxis + from . import yaxis + from . import zaxis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".annotation", ".camera", ".xaxis", ".yaxis", ".zaxis"], + [ + "._annotation.Annotation", + "._aspectratio.Aspectratio", + "._camera.Camera", + "._domain.Domain", + "._xaxis.XAxis", + "._yaxis.YAxis", + "._zaxis.ZAxis", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_annotation.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_annotation.py new file mode 100644 index 0000000..341cb4b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_annotation.py @@ -0,0 +1,1243 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Annotation(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.annotation" + _valid_props = { + "align", + "arrowcolor", + "arrowhead", + "arrowside", + "arrowsize", + "arrowwidth", + "ax", + "ay", + "bgcolor", + "bordercolor", + "borderpad", + "borderwidth", + "captureevents", + "font", + "height", + "hoverlabel", + "hovertext", + "name", + "opacity", + "showarrow", + "standoff", + "startarrowhead", + "startarrowsize", + "startstandoff", + "templateitemname", + "text", + "textangle", + "valign", + "visible", + "width", + "x", + "xanchor", + "xshift", + "y", + "yanchor", + "yshift", + "z", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans two or more lines (i.e. `text` + contains one or more
HTML tags) or if an explicit width is + set to override the text width. + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def arrowcolor(self): + """ + Sets the color of the annotation arrow. + + The 'arrowcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["arrowcolor"] + + @arrowcolor.setter + def arrowcolor(self, val): + self["arrowcolor"] = val + + @property + def arrowhead(self): + """ + Sets the end annotation arrow head style. + + The 'arrowhead' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 8] + + Returns + ------- + int + """ + return self["arrowhead"] + + @arrowhead.setter + def arrowhead(self, val): + self["arrowhead"] = val + + @property + def arrowside(self): + """ + Sets the annotation arrow head position. + + The 'arrowside' property is a flaglist and may be specified + as a string containing: + - Any combination of ['end', 'start'] joined with '+' characters + (e.g. 'end+start') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["arrowside"] + + @arrowside.setter + def arrowside(self, val): + self["arrowside"] = val + + @property + def arrowsize(self): + """ + Sets the size of the end annotation arrow head, relative to + `arrowwidth`. A value of 1 (default) gives a head about 3x as + wide as the line. + + The 'arrowsize' property is a number and may be specified as: + - An int or float in the interval [0.3, inf] + + Returns + ------- + int|float + """ + return self["arrowsize"] + + @arrowsize.setter + def arrowsize(self, val): + self["arrowsize"] = val + + @property + def arrowwidth(self): + """ + Sets the width (in px) of annotation arrow line. + + The 'arrowwidth' property is a number and may be specified as: + - An int or float in the interval [0.1, inf] + + Returns + ------- + int|float + """ + return self["arrowwidth"] + + @arrowwidth.setter + def arrowwidth(self, val): + self["arrowwidth"] = val + + @property + def ax(self): + """ + Sets the x component of the arrow tail about the arrow head (in + pixels). + + The 'ax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["ax"] + + @ax.setter + def ax(self, val): + self["ax"] = val + + @property + def ay(self): + """ + Sets the y component of the arrow tail about the arrow head (in + pixels). + + The 'ay' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["ay"] + + @ay.setter + def ay(self, val): + self["ay"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the annotation. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the annotation `text`. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderpad(self): + """ + Sets the padding (in px) between the `text` and the enclosing + border. + + The 'borderpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderpad"] + + @borderpad.setter + def borderpad(self, val): + self["borderpad"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the annotation + `text`. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def captureevents(self): + """ + Determines whether the annotation text box captures mouse move + and click events, or allows those events to pass through to + data points in the plot that may be behind the annotation. By + default `captureevents` is False unless `hovertext` is + provided. If you use the event `plotly_clickannotation` without + `hovertext` you must explicitly enable `captureevents`. + + The 'captureevents' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["captureevents"] + + @captureevents.setter + def captureevents(self, val): + self["captureevents"] = val + + @property + def font(self): + """ + Sets the annotation text font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.annotation.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.scene.annotation.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def height(self): + """ + Sets an explicit height for the text box. null (default) lets + the text set the box height. Taller text will be clipped. + + The 'height' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["height"] + + @height.setter + def height(self, val): + self["height"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.annotation.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.layout.scene.annotation.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertext(self): + """ + Sets text to appear when hovering over this annotation. If + omitted or blank, no hover label will appear. + + The 'hovertext' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hovertext"] + + @hovertext.setter + def hovertext(self, val): + self["hovertext"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def opacity(self): + """ + Sets the opacity of the annotation (text + arrow). + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def showarrow(self): + """ + Determines whether or not the annotation is drawn with an + arrow. If True, `text` is placed near the arrow's tail. If + False, `text` lines up with the `x` and `y` provided. + + The 'showarrow' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showarrow"] + + @showarrow.setter + def showarrow(self, val): + self["showarrow"] = val + + @property + def standoff(self): + """ + Sets a distance, in pixels, to move the end arrowhead away from + the position it is pointing at, for example to point at the + edge of a marker independent of zoom. Note that this shortens + the arrow from the `ax` / `ay` vector, in contrast to `xshift` + / `yshift` which moves everything by this amount. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def startarrowhead(self): + """ + Sets the start annotation arrow head style. + + The 'startarrowhead' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 8] + + Returns + ------- + int + """ + return self["startarrowhead"] + + @startarrowhead.setter + def startarrowhead(self, val): + self["startarrowhead"] = val + + @property + def startarrowsize(self): + """ + Sets the size of the start annotation arrow head, relative to + `arrowwidth`. A value of 1 (default) gives a head about 3x as + wide as the line. + + The 'startarrowsize' property is a number and may be specified as: + - An int or float in the interval [0.3, inf] + + Returns + ------- + int|float + """ + return self["startarrowsize"] + + @startarrowsize.setter + def startarrowsize(self, val): + self["startarrowsize"] = val + + @property + def startstandoff(self): + """ + Sets a distance, in pixels, to move the start arrowhead away + from the position it is pointing at, for example to point at + the edge of a marker independent of zoom. Note that this + shortens the arrow from the `ax` / `ay` vector, in contrast to + `xshift` / `yshift` which moves everything by this amount. + + The 'startstandoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["startstandoff"] + + @startstandoff.setter + def startstandoff(self, val): + self["startstandoff"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def text(self): + """ + Sets the text associated with this annotation. Plotly uses a + subset of HTML tags to do things like newline (
), bold + (), italics (), hyperlinks (). + Tags , , , , are also supported. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle at which the `text` is drawn with respect to the + horizontal. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def valign(self): + """ + Sets the vertical alignment of the `text` within the box. Has + an effect only if an explicit height is set to override the + text height. + + The 'valign' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["valign"] + + @valign.setter + def valign(self, val): + self["valign"] = val + + @property + def visible(self): + """ + Determines whether or not this annotation is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets an explicit width for the text box. null (default) lets + the text set the box width. Wider text will be clipped. There + is no automatic wrapping; use
to start a new line. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def x(self): + """ + Sets the annotation's x position. + + The 'x' property accepts values of any type + + Returns + ------- + Any + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the text box's horizontal position anchor This anchor + binds the `x` position to the "left", "center" or "right" of + the annotation. For example, if `x` is set to 1, `xref` to + "paper" and `xanchor` to "right" then the right-most portion of + the annotation lines up with the right-most edge of the + plotting area. If "auto", the anchor is equivalent to "center" + for data-referenced annotations or if there is an arrow, + whereas for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xshift(self): + """ + Shifts the position of the whole annotation and arrow to the + right (positive) or left (negative) by this many pixels. + + The 'xshift' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["xshift"] + + @xshift.setter + def xshift(self, val): + self["xshift"] = val + + @property + def y(self): + """ + Sets the annotation's y position. + + The 'y' property accepts values of any type + + Returns + ------- + Any + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the text box's vertical position anchor This anchor binds + the `y` position to the "top", "middle" or "bottom" of the + annotation. For example, if `y` is set to 1, `yref` to "paper" + and `yanchor` to "top" then the top-most portion of the + annotation lines up with the top-most edge of the plotting + area. If "auto", the anchor is equivalent to "middle" for data- + referenced annotations or if there is an arrow, whereas for + paper-referenced with no arrow, the anchor picked corresponds + to the closest side. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def yshift(self): + """ + Shifts the position of the whole annotation and arrow up + (positive) or down (negative) by this many pixels. + + The 'yshift' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["yshift"] + + @yshift.setter + def yshift(self, val): + self["yshift"] = val + + @property + def z(self): + """ + Sets the annotation's z position. + + The 'z' property accepts values of any type + + Returns + ------- + Any + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head (in pixels). + ay + Sets the y component of the arrow tail about the arrow + head (in pixels). + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + :class:`plotly.graph_objects.layout.scene.annotation.Ho + verlabel` instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + z + Sets the annotation's z position. + """ + + def __init__( + self, + arg=None, + align=None, + arrowcolor=None, + arrowhead=None, + arrowside=None, + arrowsize=None, + arrowwidth=None, + ax=None, + ay=None, + bgcolor=None, + bordercolor=None, + borderpad=None, + borderwidth=None, + captureevents=None, + font=None, + height=None, + hoverlabel=None, + hovertext=None, + name=None, + opacity=None, + showarrow=None, + standoff=None, + startarrowhead=None, + startarrowsize=None, + startstandoff=None, + templateitemname=None, + text=None, + textangle=None, + valign=None, + visible=None, + width=None, + x=None, + xanchor=None, + xshift=None, + y=None, + yanchor=None, + yshift=None, + z=None, + **kwargs, + ): + """ + Construct a new Annotation object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.Annotation` + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + arrowcolor + Sets the color of the annotation arrow. + arrowhead + Sets the end annotation arrow head style. + arrowside + Sets the annotation arrow head position. + arrowsize + Sets the size of the end annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + arrowwidth + Sets the width (in px) of annotation arrow line. + ax + Sets the x component of the arrow tail about the arrow + head (in pixels). + ay + Sets the y component of the arrow tail about the arrow + head (in pixels). + bgcolor + Sets the background color of the annotation. + bordercolor + Sets the color of the border enclosing the annotation + `text`. + borderpad + Sets the padding (in px) between the `text` and the + enclosing border. + borderwidth + Sets the width (in px) of the border enclosing the + annotation `text`. + captureevents + Determines whether the annotation text box captures + mouse move and click events, or allows those events to + pass through to data points in the plot that may be + behind the annotation. By default `captureevents` is + False unless `hovertext` is provided. If you use the + event `plotly_clickannotation` without `hovertext` you + must explicitly enable `captureevents`. + font + Sets the annotation text font. + height + Sets an explicit height for the text box. null + (default) lets the text set the box height. Taller text + will be clipped. + hoverlabel + :class:`plotly.graph_objects.layout.scene.annotation.Ho + verlabel` instance or dict with compatible properties + hovertext + Sets text to appear when hovering over this annotation. + If omitted or blank, no hover label will appear. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + opacity + Sets the opacity of the annotation (text + arrow). + showarrow + Determines whether or not the annotation is drawn with + an arrow. If True, `text` is placed near the arrow's + tail. If False, `text` lines up with the `x` and `y` + provided. + standoff + Sets a distance, in pixels, to move the end arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + startarrowhead + Sets the start annotation arrow head style. + startarrowsize + Sets the size of the start annotation arrow head, + relative to `arrowwidth`. A value of 1 (default) gives + a head about 3x as wide as the line. + startstandoff + Sets a distance, in pixels, to move the start arrowhead + away from the position it is pointing at, for example + to point at the edge of a marker independent of zoom. + Note that this shortens the arrow from the `ax` / `ay` + vector, in contrast to `xshift` / `yshift` which moves + everything by this amount. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + text + Sets the text associated with this annotation. Plotly + uses a subset of HTML tags to do things like newline + (
), bold (), italics (), hyperlinks + (). Tags , , , , + are also supported. + textangle + Sets the angle at which the `text` is drawn with + respect to the horizontal. + valign + Sets the vertical alignment of the `text` within the + box. Has an effect only if an explicit height is set to + override the text height. + visible + Determines whether or not this annotation is visible. + width + Sets an explicit width for the text box. null (default) + lets the text set the box width. Wider text will be + clipped. There is no automatic wrapping; use
to + start a new line. + x + Sets the annotation's x position. + xanchor + Sets the text box's horizontal position anchor This + anchor binds the `x` position to the "left", "center" + or "right" of the annotation. For example, if `x` is + set to 1, `xref` to "paper" and `xanchor` to "right" + then the right-most portion of the annotation lines up + with the right-most edge of the plotting area. If + "auto", the anchor is equivalent to "center" for data- + referenced annotations or if there is an arrow, whereas + for paper-referenced with no arrow, the anchor picked + corresponds to the closest side. + xshift + Shifts the position of the whole annotation and arrow + to the right (positive) or left (negative) by this many + pixels. + y + Sets the annotation's y position. + yanchor + Sets the text box's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the annotation. For example, if `y` is set + to 1, `yref` to "paper" and `yanchor` to "top" then the + top-most portion of the annotation lines up with the + top-most edge of the plotting area. If "auto", the + anchor is equivalent to "middle" for data-referenced + annotations or if there is an arrow, whereas for paper- + referenced with no arrow, the anchor picked corresponds + to the closest side. + yshift + Shifts the position of the whole annotation and arrow + up (positive) or down (negative) by this many pixels. + z + Sets the annotation's z position. + + Returns + ------- + Annotation + """ + super().__init__("annotations") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.Annotation +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.Annotation`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("arrowcolor", arg, arrowcolor) + self._set_property("arrowhead", arg, arrowhead) + self._set_property("arrowside", arg, arrowside) + self._set_property("arrowsize", arg, arrowsize) + self._set_property("arrowwidth", arg, arrowwidth) + self._set_property("ax", arg, ax) + self._set_property("ay", arg, ay) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderpad", arg, borderpad) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("captureevents", arg, captureevents) + self._set_property("font", arg, font) + self._set_property("height", arg, height) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertext", arg, hovertext) + self._set_property("name", arg, name) + self._set_property("opacity", arg, opacity) + self._set_property("showarrow", arg, showarrow) + self._set_property("standoff", arg, standoff) + self._set_property("startarrowhead", arg, startarrowhead) + self._set_property("startarrowsize", arg, startarrowsize) + self._set_property("startstandoff", arg, startstandoff) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("valign", arg, valign) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xshift", arg, xshift) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("yshift", arg, yshift) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_aspectratio.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_aspectratio.py new file mode 100644 index 0000000..62e1729 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_aspectratio.py @@ -0,0 +1,119 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Aspectratio(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.aspectratio" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Aspectratio object + + Sets this scene's axis aspectratio. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.Aspectratio` + x + + y + + z + + + Returns + ------- + Aspectratio + """ + super().__init__("aspectratio") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.Aspectratio +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.Aspectratio`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_camera.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_camera.py new file mode 100644 index 0000000..cd73985 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_camera.py @@ -0,0 +1,183 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Camera(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.camera" + _valid_props = {"center", "eye", "projection", "up"} + + @property + def center(self): + """ + Sets the (x,y,z) components of the 'center' camera vector This + vector determines the translation (x,y,z) space about the + center of this scene. By default, there is no such translation. + + The 'center' property is an instance of Center + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Center` + - A dict of string/value properties that will be passed + to the Center constructor + + Returns + ------- + plotly.graph_objs.layout.scene.camera.Center + """ + return self["center"] + + @center.setter + def center(self, val): + self["center"] = val + + @property + def eye(self): + """ + Sets the (x,y,z) components of the 'eye' camera vector. This + vector determines the view point about the origin of this + scene. + + The 'eye' property is an instance of Eye + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Eye` + - A dict of string/value properties that will be passed + to the Eye constructor + + Returns + ------- + plotly.graph_objs.layout.scene.camera.Eye + """ + return self["eye"] + + @eye.setter + def eye(self, val): + self["eye"] = val + + @property + def projection(self): + """ + The 'projection' property is an instance of Projection + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Projection` + - A dict of string/value properties that will be passed + to the Projection constructor + + Returns + ------- + plotly.graph_objs.layout.scene.camera.Projection + """ + return self["projection"] + + @projection.setter + def projection(self, val): + self["projection"] = val + + @property + def up(self): + """ + Sets the (x,y,z) components of the 'up' camera vector. This + vector determines the up direction of this scene with respect + to the page. The default is *{x: 0, y: 0, z: 1}* which means + that the z axis points up. + + The 'up' property is an instance of Up + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.camera.Up` + - A dict of string/value properties that will be passed + to the Up constructor + + Returns + ------- + plotly.graph_objs.layout.scene.camera.Up + """ + return self["up"] + + @up.setter + def up(self, val): + self["up"] = val + + @property + def _prop_descriptions(self): + return """\ + center + Sets the (x,y,z) components of the 'center' camera + vector This vector determines the translation (x,y,z) + space about the center of this scene. By default, there + is no such translation. + eye + Sets the (x,y,z) components of the 'eye' camera vector. + This vector determines the view point about the origin + of this scene. + projection + :class:`plotly.graph_objects.layout.scene.camera.Projec + tion` instance or dict with compatible properties + up + Sets the (x,y,z) components of the 'up' camera vector. + This vector determines the up direction of this scene + with respect to the page. The default is *{x: 0, y: 0, + z: 1}* which means that the z axis points up. + """ + + def __init__( + self, arg=None, center=None, eye=None, projection=None, up=None, **kwargs + ): + """ + Construct a new Camera object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.Camera` + center + Sets the (x,y,z) components of the 'center' camera + vector This vector determines the translation (x,y,z) + space about the center of this scene. By default, there + is no such translation. + eye + Sets the (x,y,z) components of the 'eye' camera vector. + This vector determines the view point about the origin + of this scene. + projection + :class:`plotly.graph_objects.layout.scene.camera.Projec + tion` instance or dict with compatible properties + up + Sets the (x,y,z) components of the 'up' camera vector. + This vector determines the up direction of this scene + with respect to the page. The default is *{x: 0, y: 0, + z: 1}* which means that the z axis points up. + + Returns + ------- + Camera + """ + super().__init__("camera") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.Camera +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.Camera`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("center", arg, center) + self._set_property("eye", arg, eye) + self._set_property("projection", arg, projection) + self._set_property("up", arg, up) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_domain.py new file mode 100644 index 0000000..ef03c38 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this scene subplot . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this scene subplot . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this scene subplot (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this scene subplot (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this scene subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this scene subplot . + x + Sets the horizontal domain of this scene subplot (in + plot fraction). + y + Sets the vertical domain of this scene subplot (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this scene subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this scene subplot . + x + Sets the horizontal domain of this scene subplot (in + plot fraction). + y + Sets the vertical domain of this scene subplot (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_xaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_xaxis.py new file mode 100644 index 0000000..3158a2e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_xaxis.py @@ -0,0 +1,2111 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class XAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.xaxis" + _valid_props = { + "autorange", + "autorangeoptions", + "autotypenumbers", + "backgroundcolor", + "calendar", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "dtick", + "exponentformat", + "gridcolor", + "gridwidth", + "hoverformat", + "labelalias", + "linecolor", + "linewidth", + "maxallowed", + "minallowed", + "minexponent", + "mirror", + "nticks", + "range", + "rangemode", + "separatethousands", + "showaxeslabels", + "showbackground", + "showexponent", + "showgrid", + "showline", + "showspikes", + "showticklabels", + "showtickprefix", + "showticksuffix", + "spikecolor", + "spikesides", + "spikethickness", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "type", + "visible", + "zeroline", + "zerolinecolor", + "zerolinewidth", + } + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided and it has a value for both the lower and + upper bound, `autorange` is set to False. Using "min" applies + autorange only to set the minimum. Using "max" applies + autorange only to set the maximum. Using *min reversed* applies + autorange only to set the minimum on a reversed axis. Using + *max reversed* applies autorange only to set the maximum on a + reversed axis. Using "reversed" applies autorange on both ends + and reverses the axis direction. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autorangeoptions(self): + """ + The 'autorangeoptions' property is an instance of Autorangeoptions + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Autorangeoptions` + - A dict of string/value properties that will be passed + to the Autorangeoptions constructor + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.Autorangeoptions + """ + return self["autorangeoptions"] + + @autorangeoptions.setter + def autorangeoptions(self, val): + self["autorangeoptions"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def backgroundcolor(self): + """ + Sets the background color of this axis' wall. + + The 'backgroundcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["backgroundcolor"] + + @backgroundcolor.setter + def backgroundcolor(self, val): + self["backgroundcolor"] = val + + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def maxallowed(self): + """ + Determines the maximum range of this axis. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Determines the minimum range of this axis. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self["mirror"] + + @mirror.setter + def mirror(self, val): + self["mirror"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + Leaving either or both elements `null` impacts the default + `autorange`. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showaxeslabels(self): + """ + Sets whether or not this axis is labeled + + The 'showaxeslabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showaxeslabels"] + + @showaxeslabels.setter + def showaxeslabels(self, val): + self["showaxeslabels"] = val + + @property + def showbackground(self): + """ + Sets whether or not this axis' wall has a background color. + + The 'showbackground' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showbackground"] + + @showbackground.setter + def showbackground(self, val): + self["showbackground"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showspikes(self): + """ + Sets whether or not spikes starting from data points to this + axis' wall are shown on hover. + + The 'showspikes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showspikes"] + + @showspikes.setter + def showspikes(self, val): + self["showspikes"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def spikecolor(self): + """ + Sets the color of the spikes. + + The 'spikecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["spikecolor"] + + @spikecolor.setter + def spikecolor(self, val): + self["spikecolor"] = val + + @property + def spikesides(self): + """ + Sets whether or not spikes extending from the projection data + points to this axis' wall boundaries are shown on hover. + + The 'spikesides' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["spikesides"] + + @spikesides.setter + def spikesides(self, val): + self["spikesides"] = val + + @property + def spikethickness(self): + """ + Sets the thickness (in px) of the spikes. + + The 'spikethickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["spikethickness"] + + @spikethickness.setter + def spikethickness(self, val): + self["spikethickness"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.scene.xaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.xaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.scene.xaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.scene.xaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'log', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def zeroline(self): + """ + Determines whether or not a line is drawn at along the 0 value + of this axis. If True, the zero line is drawn on top of the + grid lines. + + The 'zeroline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zeroline"] + + @zeroline.setter + def zeroline(self, val): + self["zeroline"] = val + + @property + def zerolinecolor(self): + """ + Sets the line color of the zero line. + + The 'zerolinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["zerolinecolor"] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self["zerolinecolor"] = val + + @property + def zerolinewidth(self): + """ + Sets the width (in px) of the zero line. + + The 'zerolinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zerolinewidth"] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self["zerolinewidth"] = val + + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.scene.xaxis.Autoran + geoptions` instance or dict with compatible properties + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.scene.xa + xis.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.xaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.scene.xaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + def __init__( + self, + arg=None, + autorange=None, + autorangeoptions=None, + autotypenumbers=None, + backgroundcolor=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + linecolor=None, + linewidth=None, + maxallowed=None, + minallowed=None, + minexponent=None, + mirror=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showaxeslabels=None, + showbackground=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + spikecolor=None, + spikesides=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + type=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs, + ): + """ + Construct a new XAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.XAxis` + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.scene.xaxis.Autoran + geoptions` instance or dict with compatible properties + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.scene.xa + xis.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.xaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.xaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.scene.xaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + XAxis + """ + super().__init__("xaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.XAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.XAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autorange", arg, autorange) + self._set_property("autorangeoptions", arg, autorangeoptions) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("backgroundcolor", arg, backgroundcolor) + self._set_property("calendar", arg, calendar) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._set_property("minexponent", arg, minexponent) + self._set_property("mirror", arg, mirror) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showaxeslabels", arg, showaxeslabels) + self._set_property("showbackground", arg, showbackground) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showspikes", arg, showspikes) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("spikecolor", arg, spikecolor) + self._set_property("spikesides", arg, spikesides) + self._set_property("spikethickness", arg, spikethickness) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._set_property("zeroline", arg, zeroline) + self._set_property("zerolinecolor", arg, zerolinecolor) + self._set_property("zerolinewidth", arg, zerolinewidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_yaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_yaxis.py new file mode 100644 index 0000000..852837d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_yaxis.py @@ -0,0 +1,2111 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class YAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.yaxis" + _valid_props = { + "autorange", + "autorangeoptions", + "autotypenumbers", + "backgroundcolor", + "calendar", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "dtick", + "exponentformat", + "gridcolor", + "gridwidth", + "hoverformat", + "labelalias", + "linecolor", + "linewidth", + "maxallowed", + "minallowed", + "minexponent", + "mirror", + "nticks", + "range", + "rangemode", + "separatethousands", + "showaxeslabels", + "showbackground", + "showexponent", + "showgrid", + "showline", + "showspikes", + "showticklabels", + "showtickprefix", + "showticksuffix", + "spikecolor", + "spikesides", + "spikethickness", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "type", + "visible", + "zeroline", + "zerolinecolor", + "zerolinewidth", + } + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided and it has a value for both the lower and + upper bound, `autorange` is set to False. Using "min" applies + autorange only to set the minimum. Using "max" applies + autorange only to set the maximum. Using *min reversed* applies + autorange only to set the minimum on a reversed axis. Using + *max reversed* applies autorange only to set the maximum on a + reversed axis. Using "reversed" applies autorange on both ends + and reverses the axis direction. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autorangeoptions(self): + """ + The 'autorangeoptions' property is an instance of Autorangeoptions + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Autorangeoptions` + - A dict of string/value properties that will be passed + to the Autorangeoptions constructor + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.Autorangeoptions + """ + return self["autorangeoptions"] + + @autorangeoptions.setter + def autorangeoptions(self, val): + self["autorangeoptions"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def backgroundcolor(self): + """ + Sets the background color of this axis' wall. + + The 'backgroundcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["backgroundcolor"] + + @backgroundcolor.setter + def backgroundcolor(self, val): + self["backgroundcolor"] = val + + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def maxallowed(self): + """ + Determines the maximum range of this axis. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Determines the minimum range of this axis. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self["mirror"] + + @mirror.setter + def mirror(self, val): + self["mirror"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + Leaving either or both elements `null` impacts the default + `autorange`. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showaxeslabels(self): + """ + Sets whether or not this axis is labeled + + The 'showaxeslabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showaxeslabels"] + + @showaxeslabels.setter + def showaxeslabels(self, val): + self["showaxeslabels"] = val + + @property + def showbackground(self): + """ + Sets whether or not this axis' wall has a background color. + + The 'showbackground' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showbackground"] + + @showbackground.setter + def showbackground(self, val): + self["showbackground"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showspikes(self): + """ + Sets whether or not spikes starting from data points to this + axis' wall are shown on hover. + + The 'showspikes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showspikes"] + + @showspikes.setter + def showspikes(self, val): + self["showspikes"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def spikecolor(self): + """ + Sets the color of the spikes. + + The 'spikecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["spikecolor"] + + @spikecolor.setter + def spikecolor(self, val): + self["spikecolor"] = val + + @property + def spikesides(self): + """ + Sets whether or not spikes extending from the projection data + points to this axis' wall boundaries are shown on hover. + + The 'spikesides' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["spikesides"] + + @spikesides.setter + def spikesides(self, val): + self["spikesides"] = val + + @property + def spikethickness(self): + """ + Sets the thickness (in px) of the spikes. + + The 'spikethickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["spikethickness"] + + @spikethickness.setter + def spikethickness(self, val): + self["spikethickness"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.scene.yaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.yaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.scene.yaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.scene.yaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'log', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def zeroline(self): + """ + Determines whether or not a line is drawn at along the 0 value + of this axis. If True, the zero line is drawn on top of the + grid lines. + + The 'zeroline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zeroline"] + + @zeroline.setter + def zeroline(self, val): + self["zeroline"] = val + + @property + def zerolinecolor(self): + """ + Sets the line color of the zero line. + + The 'zerolinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["zerolinecolor"] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self["zerolinecolor"] = val + + @property + def zerolinewidth(self): + """ + Sets the width (in px) of the zero line. + + The 'zerolinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zerolinewidth"] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self["zerolinewidth"] = val + + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.scene.yaxis.Autoran + geoptions` instance or dict with compatible properties + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.scene.ya + xis.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.yaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.scene.yaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + def __init__( + self, + arg=None, + autorange=None, + autorangeoptions=None, + autotypenumbers=None, + backgroundcolor=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + linecolor=None, + linewidth=None, + maxallowed=None, + minallowed=None, + minexponent=None, + mirror=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showaxeslabels=None, + showbackground=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + spikecolor=None, + spikesides=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + type=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs, + ): + """ + Construct a new YAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.YAxis` + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.scene.yaxis.Autoran + geoptions` instance or dict with compatible properties + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.scene.ya + xis.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.yaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.yaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.scene.yaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + YAxis + """ + super().__init__("yaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.YAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.YAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autorange", arg, autorange) + self._set_property("autorangeoptions", arg, autorangeoptions) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("backgroundcolor", arg, backgroundcolor) + self._set_property("calendar", arg, calendar) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._set_property("minexponent", arg, minexponent) + self._set_property("mirror", arg, mirror) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showaxeslabels", arg, showaxeslabels) + self._set_property("showbackground", arg, showbackground) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showspikes", arg, showspikes) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("spikecolor", arg, spikecolor) + self._set_property("spikesides", arg, spikesides) + self._set_property("spikethickness", arg, spikethickness) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._set_property("zeroline", arg, zeroline) + self._set_property("zerolinecolor", arg, zerolinecolor) + self._set_property("zerolinewidth", arg, zerolinewidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_zaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_zaxis.py new file mode 100644 index 0000000..81936c6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/_zaxis.py @@ -0,0 +1,2111 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class ZAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene" + _path_str = "layout.scene.zaxis" + _valid_props = { + "autorange", + "autorangeoptions", + "autotypenumbers", + "backgroundcolor", + "calendar", + "categoryarray", + "categoryarraysrc", + "categoryorder", + "color", + "dtick", + "exponentformat", + "gridcolor", + "gridwidth", + "hoverformat", + "labelalias", + "linecolor", + "linewidth", + "maxallowed", + "minallowed", + "minexponent", + "mirror", + "nticks", + "range", + "rangemode", + "separatethousands", + "showaxeslabels", + "showbackground", + "showexponent", + "showgrid", + "showline", + "showspikes", + "showticklabels", + "showtickprefix", + "showticksuffix", + "spikecolor", + "spikesides", + "spikethickness", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "type", + "visible", + "zeroline", + "zerolinecolor", + "zerolinewidth", + } + + @property + def autorange(self): + """ + Determines whether or not the range of this axis is computed in + relation to the input data. See `rangemode` for more info. If + `range` is provided and it has a value for both the lower and + upper bound, `autorange` is set to False. Using "min" applies + autorange only to set the minimum. Using "max" applies + autorange only to set the maximum. Using *min reversed* applies + autorange only to set the minimum on a reversed axis. Using + *max reversed* applies autorange only to set the maximum on a + reversed axis. Using "reversed" applies autorange on both ends + and reverses the axis direction. + + The 'autorange' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed', 'min reversed', 'max reversed', + 'min', 'max'] + + Returns + ------- + Any + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def autorangeoptions(self): + """ + The 'autorangeoptions' property is an instance of Autorangeoptions + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Autorangeoptions` + - A dict of string/value properties that will be passed + to the Autorangeoptions constructor + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.Autorangeoptions + """ + return self["autorangeoptions"] + + @autorangeoptions.setter + def autorangeoptions(self, val): + self["autorangeoptions"] = val + + @property + def autotypenumbers(self): + """ + Using "strict" a numeric string in trace data is not converted + to a number. Using *convert types* a numeric string in trace + data may be treated as a number during automatic axis `type` + detection. Defaults to layout.autotypenumbers. + + The 'autotypenumbers' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['convert types', 'strict'] + + Returns + ------- + Any + """ + return self["autotypenumbers"] + + @autotypenumbers.setter + def autotypenumbers(self, val): + self["autotypenumbers"] = val + + @property + def backgroundcolor(self): + """ + Sets the background color of this axis' wall. + + The 'backgroundcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["backgroundcolor"] + + @backgroundcolor.setter + def backgroundcolor(self, val): + self["backgroundcolor"] = val + + @property + def calendar(self): + """ + Sets the calendar system to use for `range` and `tick0` if this + is a date axis. This does not set the calendar for interpreting + data on this axis, that's specified in the trace or via the + global `layout.calendar` + + The 'calendar' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['chinese', 'coptic', 'discworld', 'ethiopian', + 'gregorian', 'hebrew', 'islamic', 'jalali', 'julian', + 'mayan', 'nanakshahi', 'nepali', 'persian', 'taiwan', + 'thai', 'ummalqura'] + + Returns + ------- + Any + """ + return self["calendar"] + + @calendar.setter + def calendar(self, val): + self["calendar"] = val + + @property + def categoryarray(self): + """ + Sets the order in which categories on this axis appear. Only + has an effect if `categoryorder` is set to "array". Used with + `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the case of categorical + variables. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. Set `categoryorder` to *total ascending* or + *total descending* if order should be determined by the + numerical order of the values. Similarly, the order can be + determined by the min, max, sum, mean, geometric mean or median + of all the values. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array', 'total ascending', 'total descending', 'min + ascending', 'min descending', 'max ascending', 'max + descending', 'sum ascending', 'sum descending', 'mean + ascending', 'mean descending', 'geometric mean ascending', + 'geometric mean descending', 'median ascending', 'median + descending'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def maxallowed(self): + """ + Determines the maximum range of this axis. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Determines the minimum range of this axis. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def mirror(self): + """ + Determines if the axis lines or/and ticks are mirrored to the + opposite side of the plotting area. If True, the axis lines are + mirrored. If "ticks", the axis lines and ticks are mirrored. If + False, mirroring is disable. If "all", axis lines are mirrored + on all shared-axes subplots. If "allticks", axis lines and + ticks are mirrored on all shared-axes subplots. + + The 'mirror' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, 'ticks', False, 'all', 'allticks'] + + Returns + ------- + Any + """ + return self["mirror"] + + @mirror.setter + def mirror(self, val): + self["mirror"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def range(self): + """ + Sets the range of this axis. If the axis `type` is "log", then + you must take the log of your desired range (e.g. to set the + range from 1 to 100, set the range from 0 to 2). If the axis + `type` is "date", it should be date strings, like date data, + though Date objects and unix milliseconds will be accepted and + converted to strings. If the axis `type` is "category", it + should be numbers, using the scale where each category is + assigned a serial number from zero in the order it appears. + Leaving either or both elements `null` impacts the default + `autorange`. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + If "normal", the range is computed in relation to the extrema + of the input data. If "tozero", the range extends to 0, + regardless of the input data If "nonnegative", the range is + non-negative, regardless of the input data. Applies only to + linear axes. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'tozero', 'nonnegative'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showaxeslabels(self): + """ + Sets whether or not this axis is labeled + + The 'showaxeslabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showaxeslabels"] + + @showaxeslabels.setter + def showaxeslabels(self, val): + self["showaxeslabels"] = val + + @property + def showbackground(self): + """ + Sets whether or not this axis' wall has a background color. + + The 'showbackground' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showbackground"] + + @showbackground.setter + def showbackground(self, val): + self["showbackground"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showspikes(self): + """ + Sets whether or not spikes starting from data points to this + axis' wall are shown on hover. + + The 'showspikes' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showspikes"] + + @showspikes.setter + def showspikes(self, val): + self["showspikes"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def spikecolor(self): + """ + Sets the color of the spikes. + + The 'spikecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["spikecolor"] + + @spikecolor.setter + def spikecolor(self, val): + self["spikecolor"] = val + + @property + def spikesides(self): + """ + Sets whether or not spikes extending from the projection data + points to this axis' wall boundaries are shown on hover. + + The 'spikesides' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["spikesides"] + + @spikesides.setter + def spikesides(self, val): + self["spikesides"] = val + + @property + def spikethickness(self): + """ + Sets the thickness (in px) of the spikes. + + The 'spikethickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["spikethickness"] + + @spikethickness.setter + def spikethickness(self, val): + self["spikethickness"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.scene.zaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.scene.zaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.scene.zaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.scene.zaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def type(self): + """ + Sets the axis type. By default, plotly attempts to determined + the axis type by looking into the data of the traces that + referenced the axis in question. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['-', 'linear', 'log', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def zeroline(self): + """ + Determines whether or not a line is drawn at along the 0 value + of this axis. If True, the zero line is drawn on top of the + grid lines. + + The 'zeroline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["zeroline"] + + @zeroline.setter + def zeroline(self, val): + self["zeroline"] = val + + @property + def zerolinecolor(self): + """ + Sets the line color of the zero line. + + The 'zerolinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["zerolinecolor"] + + @zerolinecolor.setter + def zerolinecolor(self, val): + self["zerolinecolor"] = val + + @property + def zerolinewidth(self): + """ + Sets the width (in px) of the zero line. + + The 'zerolinewidth' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["zerolinewidth"] + + @zerolinewidth.setter + def zerolinewidth(self, val): + self["zerolinewidth"] = val + + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.scene.zaxis.Autoran + geoptions` instance or dict with compatible properties + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.scene.za + xis.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.zaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.zaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.scene.zaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + """ + + def __init__( + self, + arg=None, + autorange=None, + autorangeoptions=None, + autotypenumbers=None, + backgroundcolor=None, + calendar=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + linecolor=None, + linewidth=None, + maxallowed=None, + minallowed=None, + minexponent=None, + mirror=None, + nticks=None, + range=None, + rangemode=None, + separatethousands=None, + showaxeslabels=None, + showbackground=None, + showexponent=None, + showgrid=None, + showline=None, + showspikes=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + spikecolor=None, + spikesides=None, + spikethickness=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + type=None, + visible=None, + zeroline=None, + zerolinecolor=None, + zerolinewidth=None, + **kwargs, + ): + """ + Construct a new ZAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.ZAxis` + autorange + Determines whether or not the range of this axis is + computed in relation to the input data. See `rangemode` + for more info. If `range` is provided and it has a + value for both the lower and upper bound, `autorange` + is set to False. Using "min" applies autorange only to + set the minimum. Using "max" applies autorange only to + set the maximum. Using *min reversed* applies autorange + only to set the minimum on a reversed axis. Using *max + reversed* applies autorange only to set the maximum on + a reversed axis. Using "reversed" applies autorange on + both ends and reverses the axis direction. + autorangeoptions + :class:`plotly.graph_objects.layout.scene.zaxis.Autoran + geoptions` instance or dict with compatible properties + autotypenumbers + Using "strict" a numeric string in trace data is not + converted to a number. Using *convert types* a numeric + string in trace data may be treated as a number during + automatic axis `type` detection. Defaults to + layout.autotypenumbers. + backgroundcolor + Sets the background color of this axis' wall. + calendar + Sets the calendar system to use for `range` and `tick0` + if this is a date axis. This does not set the calendar + for interpreting data on this axis, that's specified in + the trace or via the global `layout.calendar` + categoryarray + Sets the order in which categories on this axis appear. + Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the case of + categorical variables. By default, plotly uses "trace", + which specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. Set `categoryorder` + to *total ascending* or *total descending* if order + should be determined by the numerical order of the + values. Similarly, the order can be determined by the + min, max, sum, mean, geometric mean or median of all + the values. + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + maxallowed + Determines the maximum range of this axis. + minallowed + Determines the minimum range of this axis. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + mirror + Determines if the axis lines or/and ticks are mirrored + to the opposite side of the plotting area. If True, the + axis lines are mirrored. If "ticks", the axis lines and + ticks are mirrored. If False, mirroring is disable. If + "all", axis lines are mirrored on all shared-axes + subplots. If "allticks", axis lines and ticks are + mirrored on all shared-axes subplots. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + range + Sets the range of this axis. If the axis `type` is + "log", then you must take the log of your desired range + (e.g. to set the range from 1 to 100, set the range + from 0 to 2). If the axis `type` is "date", it should + be date strings, like date data, though Date objects + and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is + assigned a serial number from zero in the order it + appears. Leaving either or both elements `null` impacts + the default `autorange`. + rangemode + If "normal", the range is computed in relation to the + extrema of the input data. If "tozero", the range + extends to 0, regardless of the input data If + "nonnegative", the range is non-negative, regardless of + the input data. Applies only to linear axes. + separatethousands + If "true", even 4-digit integers are separated + showaxeslabels + Sets whether or not this axis is labeled + showbackground + Sets whether or not this axis' wall has a background + color. + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showspikes + Sets whether or not spikes starting from data points to + this axis' wall are shown on hover. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + spikecolor + Sets the color of the spikes. + spikesides + Sets whether or not spikes extending from the + projection data points to this axis' wall boundaries + are shown on hover. + spikethickness + Sets the thickness (in px) of the spikes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.scene.za + xis.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.layout.scen + e.zaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.scene.zaxis.tickformatstops + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.scene.zaxis.Title` + instance or dict with compatible properties + type + Sets the axis type. By default, plotly attempts to + determined the axis type by looking into the data of + the traces that referenced the axis in question. + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + zeroline + Determines whether or not a line is drawn at along the + 0 value of this axis. If True, the zero line is drawn + on top of the grid lines. + zerolinecolor + Sets the line color of the zero line. + zerolinewidth + Sets the width (in px) of the zero line. + + Returns + ------- + ZAxis + """ + super().__init__("zaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.ZAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.ZAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autorange", arg, autorange) + self._set_property("autorangeoptions", arg, autorangeoptions) + self._set_property("autotypenumbers", arg, autotypenumbers) + self._set_property("backgroundcolor", arg, backgroundcolor) + self._set_property("calendar", arg, calendar) + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._set_property("minexponent", arg, minexponent) + self._set_property("mirror", arg, mirror) + self._set_property("nticks", arg, nticks) + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showaxeslabels", arg, showaxeslabels) + self._set_property("showbackground", arg, showbackground) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showspikes", arg, showspikes) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("spikecolor", arg, spikecolor) + self._set_property("spikesides", arg, spikesides) + self._set_property("spikethickness", arg, spikethickness) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("type", arg, type) + self._set_property("visible", arg, visible) + self._set_property("zeroline", arg, zeroline) + self._set_property("zerolinecolor", arg, zerolinecolor) + self._set_property("zerolinewidth", arg, zerolinewidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/__init__.py new file mode 100644 index 0000000..372a9f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font + from ._hoverlabel import Hoverlabel + from . import hoverlabel +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".hoverlabel"], ["._font.Font", "._hoverlabel.Hoverlabel"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_font.py new file mode 100644 index 0000000..d4a686a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.annotation" + _path_str = "layout.scene.annotation.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the annotation text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.annotation.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.annotation.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.annotation.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py new file mode 100644 index 0000000..32232be --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/_hoverlabel.py @@ -0,0 +1,151 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.annotation" + _path_str = "layout.scene.annotation.hoverlabel" + _valid_props = {"bgcolor", "bordercolor", "font"} + + @property + def bgcolor(self): + """ + Sets the background color of the hover label. By default uses + the annotation's `bgcolor` made opaque, or white if it was + transparent. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover label. By default uses + either dark grey or white, for maximum contrast with + `hoverlabel.bgcolor`. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def font(self): + """ + Sets the hover label text font. By default uses the global + hover font and size, with color from `hoverlabel.bordercolor`. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.annotation.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.scene.annotation.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + """ + + def __init__(self, arg=None, bgcolor=None, bordercolor=None, font=None, **kwargs): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.a + nnotation.Hoverlabel` + bgcolor + Sets the background color of the hover label. By + default uses the annotation's `bgcolor` made opaque, or + white if it was transparent. + bordercolor + Sets the border color of the hover label. By default + uses either dark grey or white, for maximum contrast + with `hoverlabel.bgcolor`. + font + Sets the hover label text font. By default uses the + global hover font and size, with color from + `hoverlabel.bordercolor`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.annotation.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.annotation.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("font", arg, font) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py new file mode 100644 index 0000000..04b66f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/annotation/hoverlabel/_font.py @@ -0,0 +1,335 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.annotation.hoverlabel" + _path_str = "layout.scene.annotation.hoverlabel.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the hover label text font. By default uses the global + hover font and size, with color from `hoverlabel.bordercolor`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.a + nnotation.hoverlabel.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.annotation.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.annotation.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/__init__.py new file mode 100644 index 0000000..76c8894 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._center import Center + from ._eye import Eye + from ._projection import Projection + from ._up import Up +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [], + ["._center.Center", "._eye.Eye", "._projection.Projection", "._up.Up"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_center.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_center.py new file mode 100644 index 0000000..b64f441 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_center.py @@ -0,0 +1,121 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Center(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.camera" + _path_str = "layout.scene.camera.center" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Center object + + Sets the (x,y,z) components of the 'center' camera vector This + vector determines the translation (x,y,z) space about the + center of this scene. By default, there is no such translation. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.camera.Center` + x + + y + + z + + + Returns + ------- + Center + """ + super().__init__("center") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.camera.Center +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.camera.Center`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_eye.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_eye.py new file mode 100644 index 0000000..19767a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_eye.py @@ -0,0 +1,121 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Eye(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.camera" + _path_str = "layout.scene.camera.eye" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Eye object + + Sets the (x,y,z) components of the 'eye' camera vector. This + vector determines the view point about the origin of this + scene. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.camera.Eye` + x + + y + + z + + + Returns + ------- + Eye + """ + super().__init__("eye") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.camera.Eye +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.camera.Eye`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_projection.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_projection.py new file mode 100644 index 0000000..58b936e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_projection.py @@ -0,0 +1,83 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Projection(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.camera" + _path_str = "layout.scene.camera.projection" + _valid_props = {"type"} + + @property + def type(self): + """ + Sets the projection type. The projection type could be either + "perspective" or "orthographic". The default is "perspective". + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['perspective', 'orthographic'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def _prop_descriptions(self): + return """\ + type + Sets the projection type. The projection type could be + either "perspective" or "orthographic". The default is + "perspective". + """ + + def __init__(self, arg=None, type=None, **kwargs): + """ + Construct a new Projection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.c + amera.Projection` + type + Sets the projection type. The projection type could be + either "perspective" or "orthographic". The default is + "perspective". + + Returns + ------- + Projection + """ + super().__init__("projection") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.camera.Projection +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.camera.Projection`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("type", arg, type) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_up.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_up.py new file mode 100644 index 0000000..1f307ec --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/camera/_up.py @@ -0,0 +1,122 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Up(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.camera" + _path_str = "layout.scene.camera.up" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + + y + + z + + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Up object + + Sets the (x,y,z) components of the 'up' camera vector. This + vector determines the up direction of this scene with respect + to the page. The default is *{x: 0, y: 0, z: 1}* which means + that the z axis points up. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.camera.Up` + x + + y + + z + + + Returns + ------- + Up + """ + super().__init__("up") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.camera.Up +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.camera.Up`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/__init__.py new file mode 100644 index 0000000..d58e980 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/__init__.py @@ -0,0 +1,22 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._autorangeoptions import Autorangeoptions + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + [ + "._autorangeoptions.Autorangeoptions", + "._tickfont.Tickfont", + "._tickformatstop.Tickformatstop", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_autorangeoptions.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_autorangeoptions.py new file mode 100644 index 0000000..707a38e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_autorangeoptions.py @@ -0,0 +1,216 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Autorangeoptions(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.xaxis" + _path_str = "layout.scene.xaxis.autorangeoptions" + _valid_props = { + "clipmax", + "clipmin", + "include", + "includesrc", + "maxallowed", + "minallowed", + } + + @property + def clipmax(self): + """ + Clip autorange maximum if it goes beyond this value. Has no + effect when `autorangeoptions.maxallowed` is provided. + + The 'clipmax' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmax"] + + @clipmax.setter + def clipmax(self, val): + self["clipmax"] = val + + @property + def clipmin(self): + """ + Clip autorange minimum if it goes beyond this value. Has no + effect when `autorangeoptions.minallowed` is provided. + + The 'clipmin' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmin"] + + @clipmin.setter + def clipmin(self, val): + self["clipmin"] = val + + @property + def include(self): + """ + Ensure this value is included in autorange. + + The 'include' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["include"] + + @include.setter + def include(self, val): + self["include"] = val + + @property + def includesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `include`. + + The 'includesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["includesrc"] + + @includesrc.setter + def includesrc(self, val): + self["includesrc"] = val + + @property + def maxallowed(self): + """ + Use this value exactly as autorange maximum. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Use this value exactly as autorange minimum. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def _prop_descriptions(self): + return """\ + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + """ + + def __init__( + self, + arg=None, + clipmax=None, + clipmin=None, + include=None, + includesrc=None, + maxallowed=None, + minallowed=None, + **kwargs, + ): + """ + Construct a new Autorangeoptions object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.x + axis.Autorangeoptions` + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + + Returns + ------- + Autorangeoptions + """ + super().__init__("autorangeoptions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Autorangeoptions +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Autorangeoptions`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("clipmax", arg, clipmax) + self._set_property("clipmin", arg, clipmin) + self._set_property("include", arg, include) + self._set_property("includesrc", arg, includesrc) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickfont.py new file mode 100644 index 0000000..d9d2628 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.xaxis" + _path_str = "layout.scene.xaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.xaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py new file mode 100644 index 0000000..8953f2c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.xaxis" + _path_str = "layout.scene.xaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.x + axis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_title.py new file mode 100644 index 0000000..b2be9aa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.xaxis" + _path_str = "layout.scene.xaxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.xaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.scene.xaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.xaxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/_font.py new file mode 100644 index 0000000..46dc7b4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/xaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.xaxis.title" + _path_str = "layout.scene.xaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.x + axis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.xaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.xaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/__init__.py new file mode 100644 index 0000000..d58e980 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/__init__.py @@ -0,0 +1,22 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._autorangeoptions import Autorangeoptions + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + [ + "._autorangeoptions.Autorangeoptions", + "._tickfont.Tickfont", + "._tickformatstop.Tickformatstop", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_autorangeoptions.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_autorangeoptions.py new file mode 100644 index 0000000..1f57def --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_autorangeoptions.py @@ -0,0 +1,216 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Autorangeoptions(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.yaxis" + _path_str = "layout.scene.yaxis.autorangeoptions" + _valid_props = { + "clipmax", + "clipmin", + "include", + "includesrc", + "maxallowed", + "minallowed", + } + + @property + def clipmax(self): + """ + Clip autorange maximum if it goes beyond this value. Has no + effect when `autorangeoptions.maxallowed` is provided. + + The 'clipmax' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmax"] + + @clipmax.setter + def clipmax(self, val): + self["clipmax"] = val + + @property + def clipmin(self): + """ + Clip autorange minimum if it goes beyond this value. Has no + effect when `autorangeoptions.minallowed` is provided. + + The 'clipmin' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmin"] + + @clipmin.setter + def clipmin(self, val): + self["clipmin"] = val + + @property + def include(self): + """ + Ensure this value is included in autorange. + + The 'include' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["include"] + + @include.setter + def include(self, val): + self["include"] = val + + @property + def includesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `include`. + + The 'includesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["includesrc"] + + @includesrc.setter + def includesrc(self, val): + self["includesrc"] = val + + @property + def maxallowed(self): + """ + Use this value exactly as autorange maximum. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Use this value exactly as autorange minimum. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def _prop_descriptions(self): + return """\ + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + """ + + def __init__( + self, + arg=None, + clipmax=None, + clipmin=None, + include=None, + includesrc=None, + maxallowed=None, + minallowed=None, + **kwargs, + ): + """ + Construct a new Autorangeoptions object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.y + axis.Autorangeoptions` + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + + Returns + ------- + Autorangeoptions + """ + super().__init__("autorangeoptions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Autorangeoptions +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Autorangeoptions`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("clipmax", arg, clipmax) + self._set_property("clipmin", arg, clipmin) + self._set_property("include", arg, include) + self._set_property("includesrc", arg, includesrc) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickfont.py new file mode 100644 index 0000000..ff12147 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.yaxis" + _path_str = "layout.scene.yaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.yaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py new file mode 100644 index 0000000..faf7540 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.yaxis" + _path_str = "layout.scene.yaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.y + axis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_title.py new file mode 100644 index 0000000..296c622 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.yaxis" + _path_str = "layout.scene.yaxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.yaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.scene.yaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.yaxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/_font.py new file mode 100644 index 0000000..81c436c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/yaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.yaxis.title" + _path_str = "layout.scene.yaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.y + axis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.yaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.yaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/__init__.py new file mode 100644 index 0000000..d58e980 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/__init__.py @@ -0,0 +1,22 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._autorangeoptions import Autorangeoptions + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + [ + "._autorangeoptions.Autorangeoptions", + "._tickfont.Tickfont", + "._tickformatstop.Tickformatstop", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_autorangeoptions.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_autorangeoptions.py new file mode 100644 index 0000000..ca4a8db --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_autorangeoptions.py @@ -0,0 +1,216 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Autorangeoptions(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.zaxis" + _path_str = "layout.scene.zaxis.autorangeoptions" + _valid_props = { + "clipmax", + "clipmin", + "include", + "includesrc", + "maxallowed", + "minallowed", + } + + @property + def clipmax(self): + """ + Clip autorange maximum if it goes beyond this value. Has no + effect when `autorangeoptions.maxallowed` is provided. + + The 'clipmax' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmax"] + + @clipmax.setter + def clipmax(self, val): + self["clipmax"] = val + + @property + def clipmin(self): + """ + Clip autorange minimum if it goes beyond this value. Has no + effect when `autorangeoptions.minallowed` is provided. + + The 'clipmin' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmin"] + + @clipmin.setter + def clipmin(self, val): + self["clipmin"] = val + + @property + def include(self): + """ + Ensure this value is included in autorange. + + The 'include' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["include"] + + @include.setter + def include(self, val): + self["include"] = val + + @property + def includesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `include`. + + The 'includesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["includesrc"] + + @includesrc.setter + def includesrc(self, val): + self["includesrc"] = val + + @property + def maxallowed(self): + """ + Use this value exactly as autorange maximum. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Use this value exactly as autorange minimum. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def _prop_descriptions(self): + return """\ + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + """ + + def __init__( + self, + arg=None, + clipmax=None, + clipmin=None, + include=None, + includesrc=None, + maxallowed=None, + minallowed=None, + **kwargs, + ): + """ + Construct a new Autorangeoptions object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.z + axis.Autorangeoptions` + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + + Returns + ------- + Autorangeoptions + """ + super().__init__("autorangeoptions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Autorangeoptions +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Autorangeoptions`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("clipmax", arg, clipmax) + self._set_property("clipmin", arg, clipmin) + self._set_property("include", arg, include) + self._set_property("includesrc", arg, includesrc) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickfont.py new file mode 100644 index 0000000..7146405 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.zaxis" + _path_str = "layout.scene.zaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.zaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py new file mode 100644 index 0000000..1d6cc95 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.zaxis" + _path_str = "layout.scene.zaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.z + axis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_title.py new file mode 100644 index 0000000..ae7e476 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.zaxis" + _path_str = "layout.scene.zaxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.scene.zaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.scene.zaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.scene.zaxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/_font.py new file mode 100644 index 0000000..54972c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/scene/zaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.scene.zaxis.title" + _path_str = "layout.scene.zaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.scene.z + axis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.scene.zaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.scene.zaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/_line.py new file mode 100644 index 0000000..aeecc17 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/selection/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + _parent_path_str = "layout.selection" + _path_str = "layout.selection.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.selection.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.selection.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.selection.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/__init__.py new file mode 100644 index 0000000..9192b99 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._label import Label + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from . import label + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".label", ".legendgrouptitle"], + ["._label.Label", "._legendgrouptitle.Legendgrouptitle", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_label.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_label.py new file mode 100644 index 0000000..81028c6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_label.py @@ -0,0 +1,396 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Label(_BaseLayoutHierarchyType): + _parent_path_str = "layout.shape" + _path_str = "layout.shape.label" + _valid_props = { + "font", + "padding", + "text", + "textangle", + "textposition", + "texttemplate", + "xanchor", + "yanchor", + } + + @property + def font(self): + """ + Sets the shape label text font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.shape.label.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.shape.label.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def padding(self): + """ + Sets padding (in px) between edge of label and edge of shape. + + The 'padding' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["padding"] + + @padding.setter + def padding(self, val): + self["padding"] = val + + @property + def text(self): + """ + Sets the text to display with shape. It is also used for legend + item if `name` is not provided. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def textangle(self): + """ + Sets the angle at which the label text is drawn with respect to + the horizontal. For lines, angle "auto" is the same angle as + the line. For all other shapes, angle "auto" is horizontal. + + The 'textangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["textangle"] + + @textangle.setter + def textangle(self, val): + self["textangle"] = val + + @property + def textposition(self): + """ + Sets the position of the label text relative to the shape. + Supported values for rectangles, circles and paths are *top + left*, *top center*, *top right*, *middle left*, *middle + center*, *middle right*, *bottom left*, *bottom center*, and + *bottom right*. Supported values for lines are "start", + "middle", and "end". Default: *middle center* for rectangles, + circles, and paths; "middle" for lines. + + The 'textposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle left', + 'middle center', 'middle right', 'bottom left', 'bottom + center', 'bottom right', 'start', 'middle', 'end'] + + Returns + ------- + Any + """ + return self["textposition"] + + @textposition.setter + def textposition(self, val): + self["textposition"] = val + + @property + def texttemplate(self): + """ + Template string used for rendering the shape's label. Note that + this will override `text`. Variables are inserted using + %{variable}, for example "x0: %{x0}". Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{x0:$.2f}". See + https://github.com/d3/d3-format/tree/v1.4.5#d3-format for + details on the formatting syntax. Dates are formatted using + d3-time-format's syntax %{variable|d3-time-format}, for example + "Day: %{x0|%m %b %Y}". See https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. A single multiplication or division + operation may be applied to numeric variables, and combined + with d3 number formatting, for example "Length in cm: + %{x0*2.54}", "%{slope*60:.1f} meters per second." For log axes, + variable values are given in log units. For date axes, x/y + coordinate variables and center variables use datetimes, while + all other variable values use values in ms. Finally, the + template string has access to variables `x0`, `x1`, `y0`, `y1`, + `slope`, `dx`, `dy`, `width`, `height`, `length`, `xcenter` and + `ycenter`. + + The 'texttemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["texttemplate"] + + @texttemplate.setter + def texttemplate(self, val): + self["texttemplate"] = val + + @property + def xanchor(self): + """ + Sets the label's horizontal position anchor This anchor binds + the specified `textposition` to the "left", "center" or "right" + of the label text. For example, if `textposition` is set to + *top right* and `xanchor` to "right" then the right-most + portion of the label text lines up with the right-most edge of + the shape. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def yanchor(self): + """ + Sets the label's vertical position anchor This anchor binds the + specified `textposition` to the "top", "middle" or "bottom" of + the label text. For example, if `textposition` is set to *top + right* and `yanchor` to "top" then the top-most portion of the + label text lines up with the top-most edge of the shape. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets the shape label text font. + padding + Sets padding (in px) between edge of label and edge of + shape. + text + Sets the text to display with shape. It is also used + for legend item if `name` is not provided. + textangle + Sets the angle at which the label text is drawn with + respect to the horizontal. For lines, angle "auto" is + the same angle as the line. For all other shapes, angle + "auto" is horizontal. + textposition + Sets the position of the label text relative to the + shape. Supported values for rectangles, circles and + paths are *top left*, *top center*, *top right*, + *middle left*, *middle center*, *middle right*, *bottom + left*, *bottom center*, and *bottom right*. Supported + values for lines are "start", "middle", and "end". + Default: *middle center* for rectangles, circles, and + paths; "middle" for lines. + texttemplate + Template string used for rendering the shape's label. + Note that this will override `text`. Variables are + inserted using %{variable}, for example "x0: %{x0}". + Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{x0:$.2f}". + See + https://github.com/d3/d3-format/tree/v1.4.5#d3-format + for details on the formatting syntax. Dates are + formatted using d3-time-format's syntax + %{variable|d3-time-format}, for example "Day: %{x0|%m + %b %Y}". See https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. A single multiplication or + division operation may be applied to numeric variables, + and combined with d3 number formatting, for example + "Length in cm: %{x0*2.54}", "%{slope*60:.1f} meters per + second." For log axes, variable values are given in log + units. For date axes, x/y coordinate variables and + center variables use datetimes, while all other + variable values use values in ms. Finally, the template + string has access to variables `x0`, `x1`, `y0`, `y1`, + `slope`, `dx`, `dy`, `width`, `height`, `length`, + `xcenter` and `ycenter`. + xanchor + Sets the label's horizontal position anchor This anchor + binds the specified `textposition` to the "left", + "center" or "right" of the label text. For example, if + `textposition` is set to *top right* and `xanchor` to + "right" then the right-most portion of the label text + lines up with the right-most edge of the shape. + yanchor + Sets the label's vertical position anchor This anchor + binds the specified `textposition` to the "top", + "middle" or "bottom" of the label text. For example, if + `textposition` is set to *top right* and `yanchor` to + "top" then the top-most portion of the label text lines + up with the top-most edge of the shape. + """ + + def __init__( + self, + arg=None, + font=None, + padding=None, + text=None, + textangle=None, + textposition=None, + texttemplate=None, + xanchor=None, + yanchor=None, + **kwargs, + ): + """ + Construct a new Label object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.shape.Label` + font + Sets the shape label text font. + padding + Sets padding (in px) between edge of label and edge of + shape. + text + Sets the text to display with shape. It is also used + for legend item if `name` is not provided. + textangle + Sets the angle at which the label text is drawn with + respect to the horizontal. For lines, angle "auto" is + the same angle as the line. For all other shapes, angle + "auto" is horizontal. + textposition + Sets the position of the label text relative to the + shape. Supported values for rectangles, circles and + paths are *top left*, *top center*, *top right*, + *middle left*, *middle center*, *middle right*, *bottom + left*, *bottom center*, and *bottom right*. Supported + values for lines are "start", "middle", and "end". + Default: *middle center* for rectangles, circles, and + paths; "middle" for lines. + texttemplate + Template string used for rendering the shape's label. + Note that this will override `text`. Variables are + inserted using %{variable}, for example "x0: %{x0}". + Numbers are formatted using d3-format's syntax + %{variable:d3-format}, for example "Price: %{x0:$.2f}". + See + https://github.com/d3/d3-format/tree/v1.4.5#d3-format + for details on the formatting syntax. Dates are + formatted using d3-time-format's syntax + %{variable|d3-time-format}, for example "Day: %{x0|%m + %b %Y}". See https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. A single multiplication or + division operation may be applied to numeric variables, + and combined with d3 number formatting, for example + "Length in cm: %{x0*2.54}", "%{slope*60:.1f} meters per + second." For log axes, variable values are given in log + units. For date axes, x/y coordinate variables and + center variables use datetimes, while all other + variable values use values in ms. Finally, the template + string has access to variables `x0`, `x1`, `y0`, `y1`, + `slope`, `dx`, `dy`, `width`, `height`, `length`, + `xcenter` and `ycenter`. + xanchor + Sets the label's horizontal position anchor This anchor + binds the specified `textposition` to the "left", + "center" or "right" of the label text. For example, if + `textposition` is set to *top right* and `xanchor` to + "right" then the right-most portion of the label text + lines up with the right-most edge of the shape. + yanchor + Sets the label's vertical position anchor This anchor + binds the specified `textposition` to the "top", + "middle" or "bottom" of the label text. For example, if + `textposition` is set to *top right* and `yanchor` to + "top" then the top-most portion of the label text lines + up with the top-most edge of the shape. + + Returns + ------- + Label + """ + super().__init__("label") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.shape.Label +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.shape.Label`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("padding", arg, padding) + self._set_property("text", arg, text) + self._set_property("textangle", arg, textangle) + self._set_property("textposition", arg, textposition) + self._set_property("texttemplate", arg, texttemplate) + self._set_property("xanchor", arg, xanchor) + self._set_property("yanchor", arg, yanchor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_legendgrouptitle.py new file mode 100644 index 0000000..898c1fb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseLayoutHierarchyType): + _parent_path_str = "layout.shape" + _path_str = "layout.shape.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.shape.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.shape.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.shape.L + egendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.shape.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.shape.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_line.py new file mode 100644 index 0000000..b59b472 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Line(_BaseLayoutHierarchyType): + _parent_path_str = "layout.shape" + _path_str = "layout.shape.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.shape.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.shape.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.shape.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/_font.py new file mode 100644 index 0000000..d80142d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/label/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.shape.label" + _path_str = "layout.shape.label.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the shape label text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.shape.label.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.shape.label.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.shape.label.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/_font.py new file mode 100644 index 0000000..c547c64 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/shape/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.shape.legendgrouptitle" + _path_str = "layout.shape.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.shape.l + egendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.shape.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.shape.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/__init__.py new file mode 100644 index 0000000..071bb99 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/__init__.py @@ -0,0 +1,24 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._currentvalue import Currentvalue + from ._font import Font + from ._pad import Pad + from ._step import Step + from ._transition import Transition + from . import currentvalue +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".currentvalue"], + [ + "._currentvalue.Currentvalue", + "._font.Font", + "._pad.Pad", + "._step.Step", + "._transition.Transition", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_currentvalue.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_currentvalue.py new file mode 100644 index 0000000..d25d72b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_currentvalue.py @@ -0,0 +1,220 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Currentvalue(_BaseLayoutHierarchyType): + _parent_path_str = "layout.slider" + _path_str = "layout.slider.currentvalue" + _valid_props = {"font", "offset", "prefix", "suffix", "visible", "xanchor"} + + @property + def font(self): + """ + Sets the font of the current value label text. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.slider.currentvalue.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.slider.currentvalue.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def offset(self): + """ + The amount of space, in pixels, between the current value label + and the slider. + + The 'offset' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["offset"] + + @offset.setter + def offset(self, val): + self["offset"] = val + + @property + def prefix(self): + """ + When currentvalue.visible is true, this sets the prefix of the + label. + + The 'prefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["prefix"] + + @prefix.setter + def prefix(self, val): + self["prefix"] = val + + @property + def suffix(self): + """ + When currentvalue.visible is true, this sets the suffix of the + label. + + The 'suffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["suffix"] + + @suffix.setter + def suffix(self, val): + self["suffix"] = val + + @property + def visible(self): + """ + Shows the currently-selected value above the slider. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def xanchor(self): + """ + The alignment of the value readout relative to the length of + the slider. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets the font of the current value label text. + offset + The amount of space, in pixels, between the current + value label and the slider. + prefix + When currentvalue.visible is true, this sets the prefix + of the label. + suffix + When currentvalue.visible is true, this sets the suffix + of the label. + visible + Shows the currently-selected value above the slider. + xanchor + The alignment of the value readout relative to the + length of the slider. + """ + + def __init__( + self, + arg=None, + font=None, + offset=None, + prefix=None, + suffix=None, + visible=None, + xanchor=None, + **kwargs, + ): + """ + Construct a new Currentvalue object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.slider.Currentvalue` + font + Sets the font of the current value label text. + offset + The amount of space, in pixels, between the current + value label and the slider. + prefix + When currentvalue.visible is true, this sets the prefix + of the label. + suffix + When currentvalue.visible is true, this sets the suffix + of the label. + visible + Shows the currently-selected value above the slider. + xanchor + The alignment of the value readout relative to the + length of the slider. + + Returns + ------- + Currentvalue + """ + super().__init__("currentvalue") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.slider.Currentvalue +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.slider.Currentvalue`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("offset", arg, offset) + self._set_property("prefix", arg, prefix) + self._set_property("suffix", arg, suffix) + self._set_property("visible", arg, visible) + self._set_property("xanchor", arg, xanchor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_font.py new file mode 100644 index 0000000..4141210 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.slider" + _path_str = "layout.slider.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font of the slider step labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.slider.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.slider.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.slider.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_pad.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_pad.py new file mode 100644 index 0000000..dfee202 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_pad.py @@ -0,0 +1,159 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Pad(_BaseLayoutHierarchyType): + _parent_path_str = "layout.slider" + _path_str = "layout.slider.pad" + _valid_props = {"b", "l", "r", "t"} + + @property + def b(self): + """ + The amount of padding (in px) along the bottom of the + component. + + The 'b' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def l(self): + """ + The amount of padding (in px) on the left side of the + component. + + The 'l' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["l"] + + @l.setter + def l(self, val): + self["l"] = val + + @property + def r(self): + """ + The amount of padding (in px) on the right side of the + component. + + The 'r' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def t(self): + """ + The amount of padding (in px) along the top of the component. + + The 't' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["t"] + + @t.setter + def t(self, val): + self["t"] = val + + @property + def _prop_descriptions(self): + return """\ + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + """ + + def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): + """ + Construct a new Pad object + + Set the padding of the slider component along each side. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.slider.Pad` + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + + Returns + ------- + Pad + """ + super().__init__("pad") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.slider.Pad +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.slider.Pad`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("b", arg, b) + self._set_property("l", arg, l) + self._set_property("r", arg, r) + self._set_property("t", arg, t) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_step.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_step.py new file mode 100644 index 0000000..bcc3d92 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_step.py @@ -0,0 +1,354 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Step(_BaseLayoutHierarchyType): + _parent_path_str = "layout.slider" + _path_str = "layout.slider.step" + _valid_props = { + "args", + "execute", + "label", + "method", + "name", + "templateitemname", + "value", + "visible", + } + + @property + def args(self): + """ + Sets the arguments values to be passed to the Plotly method set + in `method` on slide. + + The 'args' property is an info array that may be specified as: + + * a list or tuple of up to 3 elements where: + (0) The 'args[0]' property accepts values of any type + (1) The 'args[1]' property accepts values of any type + (2) The 'args[2]' property accepts values of any type + + Returns + ------- + list + """ + return self["args"] + + @args.setter + def args(self, val): + self["args"] = val + + @property + def execute(self): + """ + When true, the API method is executed. When false, all other + behaviors are the same and command execution is skipped. This + may be useful when hooking into, for example, the + `plotly_sliderchange` method and executing the API command + manually without losing the benefit of the slider automatically + binding to the state of the plot through the specification of + `method` and `args`. + + The 'execute' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["execute"] + + @execute.setter + def execute(self, val): + self["execute"] = val + + @property + def label(self): + """ + Sets the text label to appear on the slider + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def method(self): + """ + Sets the Plotly method to be called when the slider value is + changed. If the `skip` method is used, the API slider will + function as normal but will perform no API calls and will not + bind automatically to state updates. This may be used to create + a component interface and attach to slider events manually via + JavaScript. + + The 'method' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['restyle', 'relayout', 'animate', 'update', 'skip'] + + Returns + ------- + Any + """ + return self["method"] + + @method.setter + def method(self, val): + self["method"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + Sets the value of the slider step, used to refer to the step + programatically. Defaults to the slider label if not provided. + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def visible(self): + """ + Determines whether or not this step is included in the slider. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + args + Sets the arguments values to be passed to the Plotly + method set in `method` on slide. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_sliderchange` method and executing + the API command manually without losing the benefit of + the slider automatically binding to the state of the + plot through the specification of `method` and `args`. + label + Sets the text label to appear on the slider + method + Sets the Plotly method to be called when the slider + value is changed. If the `skip` method is used, the API + slider will function as normal but will perform no API + calls and will not bind automatically to state updates. + This may be used to create a component interface and + attach to slider events manually via JavaScript. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + Sets the value of the slider step, used to refer to the + step programatically. Defaults to the slider label if + not provided. + visible + Determines whether or not this step is included in the + slider. + """ + + def __init__( + self, + arg=None, + args=None, + execute=None, + label=None, + method=None, + name=None, + templateitemname=None, + value=None, + visible=None, + **kwargs, + ): + """ + Construct a new Step object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.slider.Step` + args + Sets the arguments values to be passed to the Plotly + method set in `method` on slide. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_sliderchange` method and executing + the API command manually without losing the benefit of + the slider automatically binding to the state of the + plot through the specification of `method` and `args`. + label + Sets the text label to appear on the slider + method + Sets the Plotly method to be called when the slider + value is changed. If the `skip` method is used, the API + slider will function as normal but will perform no API + calls and will not bind automatically to state updates. + This may be used to create a component interface and + attach to slider events manually via JavaScript. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + Sets the value of the slider step, used to refer to the + step programatically. Defaults to the slider label if + not provided. + visible + Determines whether or not this step is included in the + slider. + + Returns + ------- + Step + """ + super().__init__("steps") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.slider.Step +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.slider.Step`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("args", arg, args) + self._set_property("execute", arg, execute) + self._set_property("label", arg, label) + self._set_property("method", arg, method) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_transition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_transition.py new file mode 100644 index 0000000..7fbc3aa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/_transition.py @@ -0,0 +1,109 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Transition(_BaseLayoutHierarchyType): + _parent_path_str = "layout.slider" + _path_str = "layout.slider.transition" + _valid_props = {"duration", "easing"} + + @property + def duration(self): + """ + Sets the duration of the slider transition + + The 'duration' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["duration"] + + @duration.setter + def duration(self, val): + self["duration"] = val + + @property + def easing(self): + """ + Sets the easing function of the slider transition + + The 'easing' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'quad', 'cubic', 'sin', 'exp', 'circle', + 'elastic', 'back', 'bounce', 'linear-in', 'quad-in', + 'cubic-in', 'sin-in', 'exp-in', 'circle-in', 'elastic-in', + 'back-in', 'bounce-in', 'linear-out', 'quad-out', + 'cubic-out', 'sin-out', 'exp-out', 'circle-out', + 'elastic-out', 'back-out', 'bounce-out', 'linear-in-out', + 'quad-in-out', 'cubic-in-out', 'sin-in-out', 'exp-in-out', + 'circle-in-out', 'elastic-in-out', 'back-in-out', + 'bounce-in-out'] + + Returns + ------- + Any + """ + return self["easing"] + + @easing.setter + def easing(self, val): + self["easing"] = val + + @property + def _prop_descriptions(self): + return """\ + duration + Sets the duration of the slider transition + easing + Sets the easing function of the slider transition + """ + + def __init__(self, arg=None, duration=None, easing=None, **kwargs): + """ + Construct a new Transition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.slider.Transition` + duration + Sets the duration of the slider transition + easing + Sets the easing function of the slider transition + + Returns + ------- + Transition + """ + super().__init__("transition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.slider.Transition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.slider.Transition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("duration", arg, duration) + self._set_property("easing", arg, easing) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/_font.py new file mode 100644 index 0000000..60743f4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/slider/currentvalue/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.slider.currentvalue" + _path_str = "layout.slider.currentvalue.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font of the current value label text. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.slider. + currentvalue.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.slider.currentvalue.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.slider.currentvalue.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/__init__.py new file mode 100644 index 0000000..f809fe8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._imaginaryaxis import Imaginaryaxis + from ._realaxis import Realaxis + from . import imaginaryaxis + from . import realaxis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".imaginaryaxis", ".realaxis"], + ["._domain.Domain", "._imaginaryaxis.Imaginaryaxis", "._realaxis.Realaxis"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_domain.py new file mode 100644 index 0000000..bbfd610 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.smith" + _path_str = "layout.smith.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this smith subplot . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this smith subplot . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this smith subplot (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this smith subplot (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this smith subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this smith subplot . + x + Sets the horizontal domain of this smith subplot (in + plot fraction). + y + Sets the vertical domain of this smith subplot (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.smith.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this smith subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this smith subplot . + x + Sets the horizontal domain of this smith subplot (in + plot fraction). + y + Sets the vertical domain of this smith subplot (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.smith.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.smith.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_imaginaryaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_imaginaryaxis.py new file mode 100644 index 0000000..85ae07a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_imaginaryaxis.py @@ -0,0 +1,865 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Imaginaryaxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.smith" + _path_str = "layout.smith.imaginaryaxis" + _valid_props = { + "color", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "tickcolor", + "tickfont", + "tickformat", + "ticklen", + "tickprefix", + "ticks", + "ticksuffix", + "tickvals", + "tickvalssrc", + "tickwidth", + "visible", + } + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.smith.imaginaryaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.smith.imaginaryaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Defaults to + `realaxis.tickvals` plus the same as negatives and zero. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + ticklen + Sets the tick length (in px). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + tickvals + Sets the values at which ticks on this axis appear. + Defaults to `realaxis.tickvals` plus the same as + negatives and zero. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + def __init__( + self, + arg=None, + color=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tickcolor=None, + tickfont=None, + tickformat=None, + ticklen=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + visible=None, + **kwargs, + ): + """ + Construct a new Imaginaryaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.smith.Imaginaryaxis` + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + ticklen + Sets the tick length (in px). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + tickvals + Sets the values at which ticks on this axis appear. + Defaults to `realaxis.tickvals` plus the same as + negatives and zero. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + Imaginaryaxis + """ + super().__init__("imaginaryaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.smith.Imaginaryaxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.smith.Imaginaryaxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_realaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_realaxis.py new file mode 100644 index 0000000..7a3bf0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/_realaxis.py @@ -0,0 +1,922 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Realaxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.smith" + _path_str = "layout.smith.realaxis" + _valid_props = { + "color", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "side", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "ticklen", + "tickprefix", + "ticks", + "ticksuffix", + "tickvals", + "tickvalssrc", + "tickwidth", + "visible", + } + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def side(self): + """ + Determines on which side of real axis line the tick and tick + labels appear. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.smith.realaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.smith.realaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "top" ("bottom"), this axis' are drawn + above (below) the axis line. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def visible(self): + """ + A single toggle to hide the axis while preserving interaction + like dragging. Default is true when a cheater plot is present + on the axis, otherwise false + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of real axis line the tick and + tick labels appear. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + ticklen + Sets the tick length (in px). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "top" ("bottom"), this + axis' are drawn above (below) the axis line. + ticksuffix + Sets a tick label suffix. + tickvals + Sets the values at which ticks on this axis appear. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + """ + + def __init__( + self, + arg=None, + color=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + side=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + ticklen=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + visible=None, + **kwargs, + ): + """ + Construct a new Realaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.smith.Realaxis` + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + side + Determines on which side of real axis line the tick and + tick labels appear. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + ticklen + Sets the tick length (in px). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "top" ("bottom"), this + axis' are drawn above (below) the axis line. + ticksuffix + Sets a tick label suffix. + tickvals + Sets the values at which ticks on this axis appear. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + visible + A single toggle to hide the axis while preserving + interaction like dragging. Default is true when a + cheater plot is present on the axis, otherwise false + + Returns + ------- + Realaxis + """ + super().__init__("realaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.smith.Realaxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.smith.Realaxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("side", arg, side) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/__init__.py new file mode 100644 index 0000000..c372856 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._tickfont.Tickfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/_tickfont.py new file mode 100644 index 0000000..6ecb552 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/imaginaryaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.smith.imaginaryaxis" + _path_str = "layout.smith.imaginaryaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.smith.i + maginaryaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.smith.imaginaryaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.smith.imaginaryaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/__init__.py new file mode 100644 index 0000000..c372856 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._tickfont.Tickfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/_tickfont.py new file mode 100644 index 0000000..63d8713 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/smith/realaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.smith.realaxis" + _path_str = "layout.smith.realaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.smith.r + ealaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.smith.realaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.smith.realaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/__init__.py new file mode 100644 index 0000000..388a6b6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._data import Data + from ._layout import Layout + from . import data +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".data"], ["._data.Data", "._layout.Layout"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_data.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_data.py new file mode 100644 index 0000000..ef3b5f6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_data.py @@ -0,0 +1,1435 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Data(_BaseLayoutHierarchyType): + _parent_path_str = "layout.template" + _path_str = "layout.template.data" + _valid_props = { + "bar", + "barpolar", + "box", + "candlestick", + "carpet", + "choropleth", + "choroplethmap", + "choroplethmapbox", + "cone", + "contour", + "contourcarpet", + "densitymap", + "densitymapbox", + "funnel", + "funnelarea", + "heatmap", + "histogram", + "histogram2d", + "histogram2dcontour", + "icicle", + "image", + "indicator", + "isosurface", + "mesh3d", + "ohlc", + "parcats", + "parcoords", + "pie", + "sankey", + "scatter", + "scatter3d", + "scattercarpet", + "scattergeo", + "scattergl", + "scattermap", + "scattermapbox", + "scatterpolar", + "scatterpolargl", + "scattersmith", + "scatterternary", + "splom", + "streamtube", + "sunburst", + "surface", + "table", + "treemap", + "violin", + "volume", + "waterfall", + } + + @property + def barpolar(self): + """ + The 'barpolar' property is a tuple of instances of + Barpolar that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Barpolar + - A list or tuple of dicts of string/value properties that + will be passed to the Barpolar constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Barpolar] + """ + return self["barpolar"] + + @barpolar.setter + def barpolar(self, val): + self["barpolar"] = val + + @property + def bar(self): + """ + The 'bar' property is a tuple of instances of + Bar that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Bar + - A list or tuple of dicts of string/value properties that + will be passed to the Bar constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Bar] + """ + return self["bar"] + + @bar.setter + def bar(self, val): + self["bar"] = val + + @property + def box(self): + """ + The 'box' property is a tuple of instances of + Box that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Box + - A list or tuple of dicts of string/value properties that + will be passed to the Box constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Box] + """ + return self["box"] + + @box.setter + def box(self, val): + self["box"] = val + + @property + def candlestick(self): + """ + The 'candlestick' property is a tuple of instances of + Candlestick that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Candlestick + - A list or tuple of dicts of string/value properties that + will be passed to the Candlestick constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Candlestick] + """ + return self["candlestick"] + + @candlestick.setter + def candlestick(self, val): + self["candlestick"] = val + + @property + def carpet(self): + """ + The 'carpet' property is a tuple of instances of + Carpet that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Carpet + - A list or tuple of dicts of string/value properties that + will be passed to the Carpet constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Carpet] + """ + return self["carpet"] + + @carpet.setter + def carpet(self, val): + self["carpet"] = val + + @property + def choroplethmapbox(self): + """ + The 'choroplethmapbox' property is a tuple of instances of + Choroplethmapbox that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Choroplethmapbox + - A list or tuple of dicts of string/value properties that + will be passed to the Choroplethmapbox constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Choroplethmapbox] + """ + return self["choroplethmapbox"] + + @choroplethmapbox.setter + def choroplethmapbox(self, val): + self["choroplethmapbox"] = val + + @property + def choroplethmap(self): + """ + The 'choroplethmap' property is a tuple of instances of + Choroplethmap that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Choroplethmap + - A list or tuple of dicts of string/value properties that + will be passed to the Choroplethmap constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Choroplethmap] + """ + return self["choroplethmap"] + + @choroplethmap.setter + def choroplethmap(self, val): + self["choroplethmap"] = val + + @property + def choropleth(self): + """ + The 'choropleth' property is a tuple of instances of + Choropleth that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Choropleth + - A list or tuple of dicts of string/value properties that + will be passed to the Choropleth constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Choropleth] + """ + return self["choropleth"] + + @choropleth.setter + def choropleth(self, val): + self["choropleth"] = val + + @property + def cone(self): + """ + The 'cone' property is a tuple of instances of + Cone that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Cone + - A list or tuple of dicts of string/value properties that + will be passed to the Cone constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Cone] + """ + return self["cone"] + + @cone.setter + def cone(self, val): + self["cone"] = val + + @property + def contourcarpet(self): + """ + The 'contourcarpet' property is a tuple of instances of + Contourcarpet that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Contourcarpet + - A list or tuple of dicts of string/value properties that + will be passed to the Contourcarpet constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Contourcarpet] + """ + return self["contourcarpet"] + + @contourcarpet.setter + def contourcarpet(self, val): + self["contourcarpet"] = val + + @property + def contour(self): + """ + The 'contour' property is a tuple of instances of + Contour that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Contour + - A list or tuple of dicts of string/value properties that + will be passed to the Contour constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Contour] + """ + return self["contour"] + + @contour.setter + def contour(self, val): + self["contour"] = val + + @property + def densitymapbox(self): + """ + The 'densitymapbox' property is a tuple of instances of + Densitymapbox that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Densitymapbox + - A list or tuple of dicts of string/value properties that + will be passed to the Densitymapbox constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Densitymapbox] + """ + return self["densitymapbox"] + + @densitymapbox.setter + def densitymapbox(self, val): + self["densitymapbox"] = val + + @property + def densitymap(self): + """ + The 'densitymap' property is a tuple of instances of + Densitymap that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Densitymap + - A list or tuple of dicts of string/value properties that + will be passed to the Densitymap constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Densitymap] + """ + return self["densitymap"] + + @densitymap.setter + def densitymap(self, val): + self["densitymap"] = val + + @property + def funnelarea(self): + """ + The 'funnelarea' property is a tuple of instances of + Funnelarea that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Funnelarea + - A list or tuple of dicts of string/value properties that + will be passed to the Funnelarea constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Funnelarea] + """ + return self["funnelarea"] + + @funnelarea.setter + def funnelarea(self, val): + self["funnelarea"] = val + + @property + def funnel(self): + """ + The 'funnel' property is a tuple of instances of + Funnel that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Funnel + - A list or tuple of dicts of string/value properties that + will be passed to the Funnel constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Funnel] + """ + return self["funnel"] + + @funnel.setter + def funnel(self, val): + self["funnel"] = val + + @property + def heatmap(self): + """ + The 'heatmap' property is a tuple of instances of + Heatmap that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Heatmap + - A list or tuple of dicts of string/value properties that + will be passed to the Heatmap constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Heatmap] + """ + return self["heatmap"] + + @heatmap.setter + def heatmap(self, val): + self["heatmap"] = val + + @property + def histogram2dcontour(self): + """ + The 'histogram2dcontour' property is a tuple of instances of + Histogram2dContour that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Histogram2dContour + - A list or tuple of dicts of string/value properties that + will be passed to the Histogram2dContour constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Histogram2dContour] + """ + return self["histogram2dcontour"] + + @histogram2dcontour.setter + def histogram2dcontour(self, val): + self["histogram2dcontour"] = val + + @property + def histogram2d(self): + """ + The 'histogram2d' property is a tuple of instances of + Histogram2d that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Histogram2d + - A list or tuple of dicts of string/value properties that + will be passed to the Histogram2d constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Histogram2d] + """ + return self["histogram2d"] + + @histogram2d.setter + def histogram2d(self, val): + self["histogram2d"] = val + + @property + def histogram(self): + """ + The 'histogram' property is a tuple of instances of + Histogram that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Histogram + - A list or tuple of dicts of string/value properties that + will be passed to the Histogram constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Histogram] + """ + return self["histogram"] + + @histogram.setter + def histogram(self, val): + self["histogram"] = val + + @property + def icicle(self): + """ + The 'icicle' property is a tuple of instances of + Icicle that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Icicle + - A list or tuple of dicts of string/value properties that + will be passed to the Icicle constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Icicle] + """ + return self["icicle"] + + @icicle.setter + def icicle(self, val): + self["icicle"] = val + + @property + def image(self): + """ + The 'image' property is a tuple of instances of + Image that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Image + - A list or tuple of dicts of string/value properties that + will be passed to the Image constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Image] + """ + return self["image"] + + @image.setter + def image(self, val): + self["image"] = val + + @property + def indicator(self): + """ + The 'indicator' property is a tuple of instances of + Indicator that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Indicator + - A list or tuple of dicts of string/value properties that + will be passed to the Indicator constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Indicator] + """ + return self["indicator"] + + @indicator.setter + def indicator(self, val): + self["indicator"] = val + + @property + def isosurface(self): + """ + The 'isosurface' property is a tuple of instances of + Isosurface that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Isosurface + - A list or tuple of dicts of string/value properties that + will be passed to the Isosurface constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Isosurface] + """ + return self["isosurface"] + + @isosurface.setter + def isosurface(self, val): + self["isosurface"] = val + + @property + def mesh3d(self): + """ + The 'mesh3d' property is a tuple of instances of + Mesh3d that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Mesh3d + - A list or tuple of dicts of string/value properties that + will be passed to the Mesh3d constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Mesh3d] + """ + return self["mesh3d"] + + @mesh3d.setter + def mesh3d(self, val): + self["mesh3d"] = val + + @property + def ohlc(self): + """ + The 'ohlc' property is a tuple of instances of + Ohlc that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Ohlc + - A list or tuple of dicts of string/value properties that + will be passed to the Ohlc constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Ohlc] + """ + return self["ohlc"] + + @ohlc.setter + def ohlc(self, val): + self["ohlc"] = val + + @property + def parcats(self): + """ + The 'parcats' property is a tuple of instances of + Parcats that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Parcats + - A list or tuple of dicts of string/value properties that + will be passed to the Parcats constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Parcats] + """ + return self["parcats"] + + @parcats.setter + def parcats(self, val): + self["parcats"] = val + + @property + def parcoords(self): + """ + The 'parcoords' property is a tuple of instances of + Parcoords that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Parcoords + - A list or tuple of dicts of string/value properties that + will be passed to the Parcoords constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Parcoords] + """ + return self["parcoords"] + + @parcoords.setter + def parcoords(self, val): + self["parcoords"] = val + + @property + def pie(self): + """ + The 'pie' property is a tuple of instances of + Pie that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Pie + - A list or tuple of dicts of string/value properties that + will be passed to the Pie constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Pie] + """ + return self["pie"] + + @pie.setter + def pie(self, val): + self["pie"] = val + + @property + def sankey(self): + """ + The 'sankey' property is a tuple of instances of + Sankey that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Sankey + - A list or tuple of dicts of string/value properties that + will be passed to the Sankey constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Sankey] + """ + return self["sankey"] + + @sankey.setter + def sankey(self, val): + self["sankey"] = val + + @property + def scatter3d(self): + """ + The 'scatter3d' property is a tuple of instances of + Scatter3d that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter3d + - A list or tuple of dicts of string/value properties that + will be passed to the Scatter3d constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scatter3d] + """ + return self["scatter3d"] + + @scatter3d.setter + def scatter3d(self, val): + self["scatter3d"] = val + + @property + def scattercarpet(self): + """ + The 'scattercarpet' property is a tuple of instances of + Scattercarpet that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattercarpet + - A list or tuple of dicts of string/value properties that + will be passed to the Scattercarpet constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scattercarpet] + """ + return self["scattercarpet"] + + @scattercarpet.setter + def scattercarpet(self, val): + self["scattercarpet"] = val + + @property + def scattergeo(self): + """ + The 'scattergeo' property is a tuple of instances of + Scattergeo that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergeo + - A list or tuple of dicts of string/value properties that + will be passed to the Scattergeo constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scattergeo] + """ + return self["scattergeo"] + + @scattergeo.setter + def scattergeo(self, val): + self["scattergeo"] = val + + @property + def scattergl(self): + """ + The 'scattergl' property is a tuple of instances of + Scattergl that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattergl + - A list or tuple of dicts of string/value properties that + will be passed to the Scattergl constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scattergl] + """ + return self["scattergl"] + + @scattergl.setter + def scattergl(self, val): + self["scattergl"] = val + + @property + def scattermapbox(self): + """ + The 'scattermapbox' property is a tuple of instances of + Scattermapbox that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattermapbox + - A list or tuple of dicts of string/value properties that + will be passed to the Scattermapbox constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scattermapbox] + """ + return self["scattermapbox"] + + @scattermapbox.setter + def scattermapbox(self, val): + self["scattermapbox"] = val + + @property + def scattermap(self): + """ + The 'scattermap' property is a tuple of instances of + Scattermap that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattermap + - A list or tuple of dicts of string/value properties that + will be passed to the Scattermap constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scattermap] + """ + return self["scattermap"] + + @scattermap.setter + def scattermap(self, val): + self["scattermap"] = val + + @property + def scatterpolargl(self): + """ + The 'scatterpolargl' property is a tuple of instances of + Scatterpolargl that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolargl + - A list or tuple of dicts of string/value properties that + will be passed to the Scatterpolargl constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scatterpolargl] + """ + return self["scatterpolargl"] + + @scatterpolargl.setter + def scatterpolargl(self, val): + self["scatterpolargl"] = val + + @property + def scatterpolar(self): + """ + The 'scatterpolar' property is a tuple of instances of + Scatterpolar that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterpolar + - A list or tuple of dicts of string/value properties that + will be passed to the Scatterpolar constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scatterpolar] + """ + return self["scatterpolar"] + + @scatterpolar.setter + def scatterpolar(self, val): + self["scatterpolar"] = val + + @property + def scatter(self): + """ + The 'scatter' property is a tuple of instances of + Scatter that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatter + - A list or tuple of dicts of string/value properties that + will be passed to the Scatter constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scatter] + """ + return self["scatter"] + + @scatter.setter + def scatter(self, val): + self["scatter"] = val + + @property + def scattersmith(self): + """ + The 'scattersmith' property is a tuple of instances of + Scattersmith that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scattersmith + - A list or tuple of dicts of string/value properties that + will be passed to the Scattersmith constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scattersmith] + """ + return self["scattersmith"] + + @scattersmith.setter + def scattersmith(self, val): + self["scattersmith"] = val + + @property + def scatterternary(self): + """ + The 'scatterternary' property is a tuple of instances of + Scatterternary that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Scatterternary + - A list or tuple of dicts of string/value properties that + will be passed to the Scatterternary constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Scatterternary] + """ + return self["scatterternary"] + + @scatterternary.setter + def scatterternary(self, val): + self["scatterternary"] = val + + @property + def splom(self): + """ + The 'splom' property is a tuple of instances of + Splom that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Splom + - A list or tuple of dicts of string/value properties that + will be passed to the Splom constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Splom] + """ + return self["splom"] + + @splom.setter + def splom(self, val): + self["splom"] = val + + @property + def streamtube(self): + """ + The 'streamtube' property is a tuple of instances of + Streamtube that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Streamtube + - A list or tuple of dicts of string/value properties that + will be passed to the Streamtube constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Streamtube] + """ + return self["streamtube"] + + @streamtube.setter + def streamtube(self, val): + self["streamtube"] = val + + @property + def sunburst(self): + """ + The 'sunburst' property is a tuple of instances of + Sunburst that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Sunburst + - A list or tuple of dicts of string/value properties that + will be passed to the Sunburst constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Sunburst] + """ + return self["sunburst"] + + @sunburst.setter + def sunburst(self, val): + self["sunburst"] = val + + @property + def surface(self): + """ + The 'surface' property is a tuple of instances of + Surface that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Surface + - A list or tuple of dicts of string/value properties that + will be passed to the Surface constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Surface] + """ + return self["surface"] + + @surface.setter + def surface(self, val): + self["surface"] = val + + @property + def table(self): + """ + The 'table' property is a tuple of instances of + Table that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Table + - A list or tuple of dicts of string/value properties that + will be passed to the Table constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Table] + """ + return self["table"] + + @table.setter + def table(self, val): + self["table"] = val + + @property + def treemap(self): + """ + The 'treemap' property is a tuple of instances of + Treemap that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Treemap + - A list or tuple of dicts of string/value properties that + will be passed to the Treemap constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Treemap] + """ + return self["treemap"] + + @treemap.setter + def treemap(self, val): + self["treemap"] = val + + @property + def violin(self): + """ + The 'violin' property is a tuple of instances of + Violin that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Violin + - A list or tuple of dicts of string/value properties that + will be passed to the Violin constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Violin] + """ + return self["violin"] + + @violin.setter + def violin(self, val): + self["violin"] = val + + @property + def volume(self): + """ + The 'volume' property is a tuple of instances of + Volume that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Volume + - A list or tuple of dicts of string/value properties that + will be passed to the Volume constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Volume] + """ + return self["volume"] + + @volume.setter + def volume(self, val): + self["volume"] = val + + @property + def waterfall(self): + """ + The 'waterfall' property is a tuple of instances of + Waterfall that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.template.data.Waterfall + - A list or tuple of dicts of string/value properties that + will be passed to the Waterfall constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.template.data.Waterfall] + """ + return self["waterfall"] + + @waterfall.setter + def waterfall(self, val): + self["waterfall"] = val + + @property + def _prop_descriptions(self): + return """\ + barpolar + A tuple of :class:`plotly.graph_objects.Barpolar` + instances or dicts with compatible properties + bar + A tuple of :class:`plotly.graph_objects.Bar` instances + or dicts with compatible properties + box + A tuple of :class:`plotly.graph_objects.Box` instances + or dicts with compatible properties + candlestick + A tuple of :class:`plotly.graph_objects.Candlestick` + instances or dicts with compatible properties + carpet + A tuple of :class:`plotly.graph_objects.Carpet` + instances or dicts with compatible properties + choroplethmapbox + A tuple of + :class:`plotly.graph_objects.Choroplethmapbox` + instances or dicts with compatible properties + choroplethmap + A tuple of :class:`plotly.graph_objects.Choroplethmap` + instances or dicts with compatible properties + choropleth + A tuple of :class:`plotly.graph_objects.Choropleth` + instances or dicts with compatible properties + cone + A tuple of :class:`plotly.graph_objects.Cone` instances + or dicts with compatible properties + contourcarpet + A tuple of :class:`plotly.graph_objects.Contourcarpet` + instances or dicts with compatible properties + contour + A tuple of :class:`plotly.graph_objects.Contour` + instances or dicts with compatible properties + densitymapbox + A tuple of :class:`plotly.graph_objects.Densitymapbox` + instances or dicts with compatible properties + densitymap + A tuple of :class:`plotly.graph_objects.Densitymap` + instances or dicts with compatible properties + funnelarea + A tuple of :class:`plotly.graph_objects.Funnelarea` + instances or dicts with compatible properties + funnel + A tuple of :class:`plotly.graph_objects.Funnel` + instances or dicts with compatible properties + heatmap + A tuple of :class:`plotly.graph_objects.Heatmap` + instances or dicts with compatible properties + histogram2dcontour + A tuple of + :class:`plotly.graph_objects.Histogram2dContour` + instances or dicts with compatible properties + histogram2d + A tuple of :class:`plotly.graph_objects.Histogram2d` + instances or dicts with compatible properties + histogram + A tuple of :class:`plotly.graph_objects.Histogram` + instances or dicts with compatible properties + icicle + A tuple of :class:`plotly.graph_objects.Icicle` + instances or dicts with compatible properties + image + A tuple of :class:`plotly.graph_objects.Image` + instances or dicts with compatible properties + indicator + A tuple of :class:`plotly.graph_objects.Indicator` + instances or dicts with compatible properties + isosurface + A tuple of :class:`plotly.graph_objects.Isosurface` + instances or dicts with compatible properties + mesh3d + A tuple of :class:`plotly.graph_objects.Mesh3d` + instances or dicts with compatible properties + ohlc + A tuple of :class:`plotly.graph_objects.Ohlc` instances + or dicts with compatible properties + parcats + A tuple of :class:`plotly.graph_objects.Parcats` + instances or dicts with compatible properties + parcoords + A tuple of :class:`plotly.graph_objects.Parcoords` + instances or dicts with compatible properties + pie + A tuple of :class:`plotly.graph_objects.Pie` instances + or dicts with compatible properties + sankey + A tuple of :class:`plotly.graph_objects.Sankey` + instances or dicts with compatible properties + scatter3d + A tuple of :class:`plotly.graph_objects.Scatter3d` + instances or dicts with compatible properties + scattercarpet + A tuple of :class:`plotly.graph_objects.Scattercarpet` + instances or dicts with compatible properties + scattergeo + A tuple of :class:`plotly.graph_objects.Scattergeo` + instances or dicts with compatible properties + scattergl + A tuple of :class:`plotly.graph_objects.Scattergl` + instances or dicts with compatible properties + scattermapbox + A tuple of :class:`plotly.graph_objects.Scattermapbox` + instances or dicts with compatible properties + scattermap + A tuple of :class:`plotly.graph_objects.Scattermap` + instances or dicts with compatible properties + scatterpolargl + A tuple of :class:`plotly.graph_objects.Scatterpolargl` + instances or dicts with compatible properties + scatterpolar + A tuple of :class:`plotly.graph_objects.Scatterpolar` + instances or dicts with compatible properties + scatter + A tuple of :class:`plotly.graph_objects.Scatter` + instances or dicts with compatible properties + scattersmith + A tuple of :class:`plotly.graph_objects.Scattersmith` + instances or dicts with compatible properties + scatterternary + A tuple of :class:`plotly.graph_objects.Scatterternary` + instances or dicts with compatible properties + splom + A tuple of :class:`plotly.graph_objects.Splom` + instances or dicts with compatible properties + streamtube + A tuple of :class:`plotly.graph_objects.Streamtube` + instances or dicts with compatible properties + sunburst + A tuple of :class:`plotly.graph_objects.Sunburst` + instances or dicts with compatible properties + surface + A tuple of :class:`plotly.graph_objects.Surface` + instances or dicts with compatible properties + table + A tuple of :class:`plotly.graph_objects.Table` + instances or dicts with compatible properties + treemap + A tuple of :class:`plotly.graph_objects.Treemap` + instances or dicts with compatible properties + violin + A tuple of :class:`plotly.graph_objects.Violin` + instances or dicts with compatible properties + volume + A tuple of :class:`plotly.graph_objects.Volume` + instances or dicts with compatible properties + waterfall + A tuple of :class:`plotly.graph_objects.Waterfall` + instances or dicts with compatible properties + """ + + def __init__( + self, + arg=None, + barpolar=None, + bar=None, + box=None, + candlestick=None, + carpet=None, + choroplethmapbox=None, + choroplethmap=None, + choropleth=None, + cone=None, + contourcarpet=None, + contour=None, + densitymapbox=None, + densitymap=None, + funnelarea=None, + funnel=None, + heatmap=None, + histogram2dcontour=None, + histogram2d=None, + histogram=None, + icicle=None, + image=None, + indicator=None, + isosurface=None, + mesh3d=None, + ohlc=None, + parcats=None, + parcoords=None, + pie=None, + sankey=None, + scatter3d=None, + scattercarpet=None, + scattergeo=None, + scattergl=None, + scattermapbox=None, + scattermap=None, + scatterpolargl=None, + scatterpolar=None, + scatter=None, + scattersmith=None, + scatterternary=None, + splom=None, + streamtube=None, + sunburst=None, + surface=None, + table=None, + treemap=None, + violin=None, + volume=None, + waterfall=None, + **kwargs, + ): + """ + Construct a new Data object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.template.Data` + barpolar + A tuple of :class:`plotly.graph_objects.Barpolar` + instances or dicts with compatible properties + bar + A tuple of :class:`plotly.graph_objects.Bar` instances + or dicts with compatible properties + box + A tuple of :class:`plotly.graph_objects.Box` instances + or dicts with compatible properties + candlestick + A tuple of :class:`plotly.graph_objects.Candlestick` + instances or dicts with compatible properties + carpet + A tuple of :class:`plotly.graph_objects.Carpet` + instances or dicts with compatible properties + choroplethmapbox + A tuple of + :class:`plotly.graph_objects.Choroplethmapbox` + instances or dicts with compatible properties + choroplethmap + A tuple of :class:`plotly.graph_objects.Choroplethmap` + instances or dicts with compatible properties + choropleth + A tuple of :class:`plotly.graph_objects.Choropleth` + instances or dicts with compatible properties + cone + A tuple of :class:`plotly.graph_objects.Cone` instances + or dicts with compatible properties + contourcarpet + A tuple of :class:`plotly.graph_objects.Contourcarpet` + instances or dicts with compatible properties + contour + A tuple of :class:`plotly.graph_objects.Contour` + instances or dicts with compatible properties + densitymapbox + A tuple of :class:`plotly.graph_objects.Densitymapbox` + instances or dicts with compatible properties + densitymap + A tuple of :class:`plotly.graph_objects.Densitymap` + instances or dicts with compatible properties + funnelarea + A tuple of :class:`plotly.graph_objects.Funnelarea` + instances or dicts with compatible properties + funnel + A tuple of :class:`plotly.graph_objects.Funnel` + instances or dicts with compatible properties + heatmap + A tuple of :class:`plotly.graph_objects.Heatmap` + instances or dicts with compatible properties + histogram2dcontour + A tuple of + :class:`plotly.graph_objects.Histogram2dContour` + instances or dicts with compatible properties + histogram2d + A tuple of :class:`plotly.graph_objects.Histogram2d` + instances or dicts with compatible properties + histogram + A tuple of :class:`plotly.graph_objects.Histogram` + instances or dicts with compatible properties + icicle + A tuple of :class:`plotly.graph_objects.Icicle` + instances or dicts with compatible properties + image + A tuple of :class:`plotly.graph_objects.Image` + instances or dicts with compatible properties + indicator + A tuple of :class:`plotly.graph_objects.Indicator` + instances or dicts with compatible properties + isosurface + A tuple of :class:`plotly.graph_objects.Isosurface` + instances or dicts with compatible properties + mesh3d + A tuple of :class:`plotly.graph_objects.Mesh3d` + instances or dicts with compatible properties + ohlc + A tuple of :class:`plotly.graph_objects.Ohlc` instances + or dicts with compatible properties + parcats + A tuple of :class:`plotly.graph_objects.Parcats` + instances or dicts with compatible properties + parcoords + A tuple of :class:`plotly.graph_objects.Parcoords` + instances or dicts with compatible properties + pie + A tuple of :class:`plotly.graph_objects.Pie` instances + or dicts with compatible properties + sankey + A tuple of :class:`plotly.graph_objects.Sankey` + instances or dicts with compatible properties + scatter3d + A tuple of :class:`plotly.graph_objects.Scatter3d` + instances or dicts with compatible properties + scattercarpet + A tuple of :class:`plotly.graph_objects.Scattercarpet` + instances or dicts with compatible properties + scattergeo + A tuple of :class:`plotly.graph_objects.Scattergeo` + instances or dicts with compatible properties + scattergl + A tuple of :class:`plotly.graph_objects.Scattergl` + instances or dicts with compatible properties + scattermapbox + A tuple of :class:`plotly.graph_objects.Scattermapbox` + instances or dicts with compatible properties + scattermap + A tuple of :class:`plotly.graph_objects.Scattermap` + instances or dicts with compatible properties + scatterpolargl + A tuple of :class:`plotly.graph_objects.Scatterpolargl` + instances or dicts with compatible properties + scatterpolar + A tuple of :class:`plotly.graph_objects.Scatterpolar` + instances or dicts with compatible properties + scatter + A tuple of :class:`plotly.graph_objects.Scatter` + instances or dicts with compatible properties + scattersmith + A tuple of :class:`plotly.graph_objects.Scattersmith` + instances or dicts with compatible properties + scatterternary + A tuple of :class:`plotly.graph_objects.Scatterternary` + instances or dicts with compatible properties + splom + A tuple of :class:`plotly.graph_objects.Splom` + instances or dicts with compatible properties + streamtube + A tuple of :class:`plotly.graph_objects.Streamtube` + instances or dicts with compatible properties + sunburst + A tuple of :class:`plotly.graph_objects.Sunburst` + instances or dicts with compatible properties + surface + A tuple of :class:`plotly.graph_objects.Surface` + instances or dicts with compatible properties + table + A tuple of :class:`plotly.graph_objects.Table` + instances or dicts with compatible properties + treemap + A tuple of :class:`plotly.graph_objects.Treemap` + instances or dicts with compatible properties + violin + A tuple of :class:`plotly.graph_objects.Violin` + instances or dicts with compatible properties + volume + A tuple of :class:`plotly.graph_objects.Volume` + instances or dicts with compatible properties + waterfall + A tuple of :class:`plotly.graph_objects.Waterfall` + instances or dicts with compatible properties + + Returns + ------- + Data + """ + super().__init__("data") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.template.Data +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.template.Data`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("barpolar", arg, barpolar) + self._set_property("bar", arg, bar) + self._set_property("box", arg, box) + self._set_property("candlestick", arg, candlestick) + self._set_property("carpet", arg, carpet) + self._set_property("choroplethmapbox", arg, choroplethmapbox) + self._set_property("choroplethmap", arg, choroplethmap) + self._set_property("choropleth", arg, choropleth) + self._set_property("cone", arg, cone) + self._set_property("contourcarpet", arg, contourcarpet) + self._set_property("contour", arg, contour) + self._set_property("densitymapbox", arg, densitymapbox) + self._set_property("densitymap", arg, densitymap) + self._set_property("funnelarea", arg, funnelarea) + self._set_property("funnel", arg, funnel) + self._set_property("heatmap", arg, heatmap) + self._set_property("histogram2dcontour", arg, histogram2dcontour) + self._set_property("histogram2d", arg, histogram2d) + self._set_property("histogram", arg, histogram) + self._set_property("icicle", arg, icicle) + self._set_property("image", arg, image) + self._set_property("indicator", arg, indicator) + self._set_property("isosurface", arg, isosurface) + self._set_property("mesh3d", arg, mesh3d) + self._set_property("ohlc", arg, ohlc) + self._set_property("parcats", arg, parcats) + self._set_property("parcoords", arg, parcoords) + self._set_property("pie", arg, pie) + self._set_property("sankey", arg, sankey) + self._set_property("scatter3d", arg, scatter3d) + self._set_property("scattercarpet", arg, scattercarpet) + self._set_property("scattergeo", arg, scattergeo) + self._set_property("scattergl", arg, scattergl) + self._set_property("scattermapbox", arg, scattermapbox) + self._set_property("scattermap", arg, scattermap) + self._set_property("scatterpolargl", arg, scatterpolargl) + self._set_property("scatterpolar", arg, scatterpolar) + self._set_property("scatter", arg, scatter) + self._set_property("scattersmith", arg, scattersmith) + self._set_property("scatterternary", arg, scatterternary) + self._set_property("splom", arg, splom) + self._set_property("streamtube", arg, streamtube) + self._set_property("sunburst", arg, sunburst) + self._set_property("surface", arg, surface) + self._set_property("table", arg, table) + self._set_property("treemap", arg, treemap) + self._set_property("violin", arg, violin) + self._set_property("volume", arg, volume) + self._set_property("waterfall", arg, waterfall) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_layout.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_layout.py new file mode 100644 index 0000000..058b60b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/_layout.py @@ -0,0 +1 @@ +from plotly.graph_objs import Layout diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/__init__.py new file mode 100644 index 0000000..1ce619d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/__init__.py @@ -0,0 +1,111 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._bar import Bar + from ._barpolar import Barpolar + from ._box import Box + from ._candlestick import Candlestick + from ._carpet import Carpet + from ._choropleth import Choropleth + from ._choroplethmap import Choroplethmap + from ._choroplethmapbox import Choroplethmapbox + from ._cone import Cone + from ._contour import Contour + from ._contourcarpet import Contourcarpet + from ._densitymap import Densitymap + from ._densitymapbox import Densitymapbox + from ._funnel import Funnel + from ._funnelarea import Funnelarea + from ._heatmap import Heatmap + from ._histogram import Histogram + from ._histogram2d import Histogram2d + from ._histogram2dcontour import Histogram2dContour + from ._icicle import Icicle + from ._image import Image + from ._indicator import Indicator + from ._isosurface import Isosurface + from ._mesh3d import Mesh3d + from ._ohlc import Ohlc + from ._parcats import Parcats + from ._parcoords import Parcoords + from ._pie import Pie + from ._sankey import Sankey + from ._scatter import Scatter + from ._scatter3d import Scatter3d + from ._scattercarpet import Scattercarpet + from ._scattergeo import Scattergeo + from ._scattergl import Scattergl + from ._scattermap import Scattermap + from ._scattermapbox import Scattermapbox + from ._scatterpolar import Scatterpolar + from ._scatterpolargl import Scatterpolargl + from ._scattersmith import Scattersmith + from ._scatterternary import Scatterternary + from ._splom import Splom + from ._streamtube import Streamtube + from ._sunburst import Sunburst + from ._surface import Surface + from ._table import Table + from ._treemap import Treemap + from ._violin import Violin + from ._volume import Volume + from ._waterfall import Waterfall +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [], + [ + "._bar.Bar", + "._barpolar.Barpolar", + "._box.Box", + "._candlestick.Candlestick", + "._carpet.Carpet", + "._choropleth.Choropleth", + "._choroplethmap.Choroplethmap", + "._choroplethmapbox.Choroplethmapbox", + "._cone.Cone", + "._contour.Contour", + "._contourcarpet.Contourcarpet", + "._densitymap.Densitymap", + "._densitymapbox.Densitymapbox", + "._funnel.Funnel", + "._funnelarea.Funnelarea", + "._heatmap.Heatmap", + "._histogram.Histogram", + "._histogram2d.Histogram2d", + "._histogram2dcontour.Histogram2dContour", + "._icicle.Icicle", + "._image.Image", + "._indicator.Indicator", + "._isosurface.Isosurface", + "._mesh3d.Mesh3d", + "._ohlc.Ohlc", + "._parcats.Parcats", + "._parcoords.Parcoords", + "._pie.Pie", + "._sankey.Sankey", + "._scatter.Scatter", + "._scatter3d.Scatter3d", + "._scattercarpet.Scattercarpet", + "._scattergeo.Scattergeo", + "._scattergl.Scattergl", + "._scattermap.Scattermap", + "._scattermapbox.Scattermapbox", + "._scatterpolar.Scatterpolar", + "._scatterpolargl.Scatterpolargl", + "._scattersmith.Scattersmith", + "._scatterternary.Scatterternary", + "._splom.Splom", + "._streamtube.Streamtube", + "._sunburst.Sunburst", + "._surface.Surface", + "._table.Table", + "._treemap.Treemap", + "._violin.Violin", + "._volume.Volume", + "._waterfall.Waterfall", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_bar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_bar.py new file mode 100644 index 0000000..5a800e6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_bar.py @@ -0,0 +1 @@ +from plotly.graph_objs import Bar diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_barpolar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_barpolar.py new file mode 100644 index 0000000..18abed8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_barpolar.py @@ -0,0 +1 @@ +from plotly.graph_objs import Barpolar diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_box.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_box.py new file mode 100644 index 0000000..ffdd1d9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_box.py @@ -0,0 +1 @@ +from plotly.graph_objs import Box diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_candlestick.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_candlestick.py new file mode 100644 index 0000000..5d11b44 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_candlestick.py @@ -0,0 +1 @@ +from plotly.graph_objs import Candlestick diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_carpet.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_carpet.py new file mode 100644 index 0000000..b923d73 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_carpet.py @@ -0,0 +1 @@ +from plotly.graph_objs import Carpet diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choropleth.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choropleth.py new file mode 100644 index 0000000..733e127 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choropleth.py @@ -0,0 +1 @@ +from plotly.graph_objs import Choropleth diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmap.py new file mode 100644 index 0000000..855102a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmap.py @@ -0,0 +1 @@ +from plotly.graph_objs import Choroplethmap diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmapbox.py new file mode 100644 index 0000000..220b935 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_choroplethmapbox.py @@ -0,0 +1 @@ +from plotly.graph_objs import Choroplethmapbox diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_cone.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_cone.py new file mode 100644 index 0000000..7a28452 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_cone.py @@ -0,0 +1 @@ +from plotly.graph_objs import Cone diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contour.py new file mode 100644 index 0000000..e474909 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contour.py @@ -0,0 +1 @@ +from plotly.graph_objs import Contour diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contourcarpet.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contourcarpet.py new file mode 100644 index 0000000..6240faf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_contourcarpet.py @@ -0,0 +1 @@ +from plotly.graph_objs import Contourcarpet diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymap.py new file mode 100644 index 0000000..c73e108 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymap.py @@ -0,0 +1 @@ +from plotly.graph_objs import Densitymap diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymapbox.py new file mode 100644 index 0000000..d655b21 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_densitymapbox.py @@ -0,0 +1 @@ +from plotly.graph_objs import Densitymapbox diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnel.py new file mode 100644 index 0000000..70e2ba7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnel.py @@ -0,0 +1 @@ +from plotly.graph_objs import Funnel diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnelarea.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnelarea.py new file mode 100644 index 0000000..242d0fc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_funnelarea.py @@ -0,0 +1 @@ +from plotly.graph_objs import Funnelarea diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_heatmap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_heatmap.py new file mode 100644 index 0000000..6098ee8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_heatmap.py @@ -0,0 +1 @@ +from plotly.graph_objs import Heatmap diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram.py new file mode 100644 index 0000000..7ba4c6d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram.py @@ -0,0 +1 @@ +from plotly.graph_objs import Histogram diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2d.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2d.py new file mode 100644 index 0000000..710f7f9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2d.py @@ -0,0 +1 @@ +from plotly.graph_objs import Histogram2d diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2dcontour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2dcontour.py new file mode 100644 index 0000000..94af41a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_histogram2dcontour.py @@ -0,0 +1 @@ +from plotly.graph_objs import Histogram2dContour diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_icicle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_icicle.py new file mode 100644 index 0000000..6749cbe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_icicle.py @@ -0,0 +1 @@ +from plotly.graph_objs import Icicle diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_image.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_image.py new file mode 100644 index 0000000..828920a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_image.py @@ -0,0 +1 @@ +from plotly.graph_objs import Image diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_indicator.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_indicator.py new file mode 100644 index 0000000..a5a488f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_indicator.py @@ -0,0 +1 @@ +from plotly.graph_objs import Indicator diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_isosurface.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_isosurface.py new file mode 100644 index 0000000..5a7885a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_isosurface.py @@ -0,0 +1 @@ +from plotly.graph_objs import Isosurface diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_mesh3d.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_mesh3d.py new file mode 100644 index 0000000..2172a23 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_mesh3d.py @@ -0,0 +1 @@ +from plotly.graph_objs import Mesh3d diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_ohlc.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_ohlc.py new file mode 100644 index 0000000..d3f8574 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_ohlc.py @@ -0,0 +1 @@ +from plotly.graph_objs import Ohlc diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcats.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcats.py new file mode 100644 index 0000000..9b0290b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcats.py @@ -0,0 +1 @@ +from plotly.graph_objs import Parcats diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcoords.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcoords.py new file mode 100644 index 0000000..ccf5629 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_parcoords.py @@ -0,0 +1 @@ +from plotly.graph_objs import Parcoords diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_pie.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_pie.py new file mode 100644 index 0000000..0625fd2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_pie.py @@ -0,0 +1 @@ +from plotly.graph_objs import Pie diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sankey.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sankey.py new file mode 100644 index 0000000..b572f65 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sankey.py @@ -0,0 +1 @@ +from plotly.graph_objs import Sankey diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter.py new file mode 100644 index 0000000..afcfab3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scatter diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter3d.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter3d.py new file mode 100644 index 0000000..9314622 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatter3d.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scatter3d diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattercarpet.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattercarpet.py new file mode 100644 index 0000000..26d87ca --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattercarpet.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scattercarpet diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergeo.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergeo.py new file mode 100644 index 0000000..34308e1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergeo.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scattergeo diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergl.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergl.py new file mode 100644 index 0000000..30bd371 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattergl.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scattergl diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermap.py new file mode 100644 index 0000000..5a494e2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermap.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scattermap diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermapbox.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermapbox.py new file mode 100644 index 0000000..6c3333a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattermapbox.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scattermapbox diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolar.py new file mode 100644 index 0000000..e1417b2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolar.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scatterpolar diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolargl.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolargl.py new file mode 100644 index 0000000..60b023a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterpolargl.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scatterpolargl diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattersmith.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattersmith.py new file mode 100644 index 0000000..e2dcf41 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scattersmith.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scattersmith diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterternary.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterternary.py new file mode 100644 index 0000000..2221ead --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_scatterternary.py @@ -0,0 +1 @@ +from plotly.graph_objs import Scatterternary diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_splom.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_splom.py new file mode 100644 index 0000000..0909cdf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_splom.py @@ -0,0 +1 @@ +from plotly.graph_objs import Splom diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_streamtube.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_streamtube.py new file mode 100644 index 0000000..8b23c31 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_streamtube.py @@ -0,0 +1 @@ +from plotly.graph_objs import Streamtube diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sunburst.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sunburst.py new file mode 100644 index 0000000..1b9511c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_sunburst.py @@ -0,0 +1 @@ +from plotly.graph_objs import Sunburst diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_surface.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_surface.py new file mode 100644 index 0000000..cfaa55d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_surface.py @@ -0,0 +1 @@ +from plotly.graph_objs import Surface diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_table.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_table.py new file mode 100644 index 0000000..2b6d4ad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_table.py @@ -0,0 +1 @@ +from plotly.graph_objs import Table diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_treemap.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_treemap.py new file mode 100644 index 0000000..5c648e7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_treemap.py @@ -0,0 +1 @@ +from plotly.graph_objs import Treemap diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_violin.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_violin.py new file mode 100644 index 0000000..23221b6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_violin.py @@ -0,0 +1 @@ +from plotly.graph_objs import Violin diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_volume.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_volume.py new file mode 100644 index 0000000..1128580 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_volume.py @@ -0,0 +1 @@ +from plotly.graph_objs import Volume diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_waterfall.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_waterfall.py new file mode 100644 index 0000000..c45e785 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/template/data/_waterfall.py @@ -0,0 +1 @@ +from plotly.graph_objs import Waterfall diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/__init__.py new file mode 100644 index 0000000..a9ba0ff --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/__init__.py @@ -0,0 +1,19 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._aaxis import Aaxis + from ._baxis import Baxis + from ._caxis import Caxis + from ._domain import Domain + from . import aaxis + from . import baxis + from . import caxis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".aaxis", ".baxis", ".caxis"], + ["._aaxis.Aaxis", "._baxis.Baxis", "._caxis.Caxis", "._domain.Domain"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_aaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_aaxis.py new file mode 100644 index 0000000..636e68a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_aaxis.py @@ -0,0 +1,1474 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Aaxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary" + _path_str = "layout.ternary.aaxis" + _valid_props = { + "color", + "dtick", + "exponentformat", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "min", + "minexponent", + "nticks", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "uirevision", + } + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def min(self): + """ + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the other two + axes. The full view corresponds to all the minima set to zero. + + The 'min' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["min"] + + @min.setter + def min(self, val): + self["min"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.ternary.aaxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.ternary.aaxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.ternary.aaxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `min`, and + `title` if in `editable: true` configuration. Defaults to + `ternary.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the + other two axes. The full view corresponds to all the + minima set to zero. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.ternary. + aaxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.aaxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.ternary.aaxis.Title + ` instance or dict with compatible properties + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + """ + + def __init__( + self, + arg=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + min=None, + minexponent=None, + nticks=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + uirevision=None, + **kwargs, + ): + """ + Construct a new Aaxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.Aaxis` + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the + other two axes. The full view corresponds to all the + minima set to zero. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.ternary. + aaxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.aaxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.aaxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.ternary.aaxis.Title + ` instance or dict with compatible properties + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + + Returns + ------- + Aaxis + """ + super().__init__("aaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.Aaxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.Aaxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("min", arg, min) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("uirevision", arg, uirevision) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_baxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_baxis.py new file mode 100644 index 0000000..c660431 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_baxis.py @@ -0,0 +1,1474 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Baxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary" + _path_str = "layout.ternary.baxis" + _valid_props = { + "color", + "dtick", + "exponentformat", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "min", + "minexponent", + "nticks", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "uirevision", + } + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def min(self): + """ + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the other two + axes. The full view corresponds to all the minima set to zero. + + The 'min' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["min"] + + @min.setter + def min(self, val): + self["min"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.ternary.baxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.ternary.baxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.ternary.baxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.ternary.baxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `min`, and + `title` if in `editable: true` configuration. Defaults to + `ternary.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the + other two axes. The full view corresponds to all the + minima set to zero. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.ternary. + baxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.baxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.baxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.ternary.baxis.Title + ` instance or dict with compatible properties + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + """ + + def __init__( + self, + arg=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + min=None, + minexponent=None, + nticks=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + uirevision=None, + **kwargs, + ): + """ + Construct a new Baxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.Baxis` + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the + other two axes. The full view corresponds to all the + minima set to zero. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.ternary. + baxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.baxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.baxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.ternary.baxis.Title + ` instance or dict with compatible properties + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + + Returns + ------- + Baxis + """ + super().__init__("baxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.Baxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.Baxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("min", arg, min) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("uirevision", arg, uirevision) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_caxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_caxis.py new file mode 100644 index 0000000..486cf47 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_caxis.py @@ -0,0 +1,1474 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Caxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary" + _path_str = "layout.ternary.caxis" + _valid_props = { + "color", + "dtick", + "exponentformat", + "gridcolor", + "griddash", + "gridwidth", + "hoverformat", + "labelalias", + "layer", + "linecolor", + "linewidth", + "min", + "minexponent", + "nticks", + "separatethousands", + "showexponent", + "showgrid", + "showline", + "showticklabels", + "showtickprefix", + "showticksuffix", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "uirevision", + } + + @property + def color(self): + """ + Sets default for all colors associated with this axis all at + once: line, font, tick, and grid colors. Grid color is + lightened by blending this with the plot background Individual + pieces can override this. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def hoverformat(self): + """ + Sets the hover text formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'hoverformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hoverformat"] + + @hoverformat.setter + def hoverformat(self, val): + self["hoverformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def layer(self): + """ + Sets the layer on which this axis is displayed. If *above + traces*, this axis is displayed above all the subplot's traces + If *below traces*, this axis is displayed below all the + subplot's traces, but above the grid lines. Useful when used + together with scatter-like traces with `cliponaxis` set to + False to show markers and/or text nodes above this axis. + + The 'layer' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['above traces', 'below traces'] + + Returns + ------- + Any + """ + return self["layer"] + + @layer.setter + def layer(self, val): + self["layer"] = val + + @property + def linecolor(self): + """ + Sets the axis line color. + + The 'linecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["linecolor"] + + @linecolor.setter + def linecolor(self, val): + self["linecolor"] = val + + @property + def linewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'linewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["linewidth"] + + @linewidth.setter + def linewidth(self, val): + self["linewidth"] = val + + @property + def min(self): + """ + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the other two + axes. The full view corresponds to all the minima set to zero. + + The 'min' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["min"] + + @min.setter + def min(self, val): + self["min"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def showline(self): + """ + Determines whether or not a line bounding this axis is drawn. + + The 'showline' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showline"] + + @showline.setter + def showline(self, val): + self["showline"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the tick font. + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.ternary.caxis.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.ternary.caxis.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.layout.ternary.caxis.tickformatstopdefaults), + sets the default property values to use for elements of + layout.ternary.caxis.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def uirevision(self): + """ + Controls persistence of user-driven changes in axis `min`, and + `title` if in `editable: true` configuration. Defaults to + `ternary.uirevision`. + + The 'uirevision' property accepts values of any type + + Returns + ------- + Any + """ + return self["uirevision"] + + @uirevision.setter + def uirevision(self, val): + self["uirevision"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the + other two axes. The full view corresponds to all the + minima set to zero. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.ternary. + caxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.caxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.caxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.ternary.caxis.Title + ` instance or dict with compatible properties + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + """ + + def __init__( + self, + arg=None, + color=None, + dtick=None, + exponentformat=None, + gridcolor=None, + griddash=None, + gridwidth=None, + hoverformat=None, + labelalias=None, + layer=None, + linecolor=None, + linewidth=None, + min=None, + minexponent=None, + nticks=None, + separatethousands=None, + showexponent=None, + showgrid=None, + showline=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + uirevision=None, + **kwargs, + ): + """ + Construct a new Caxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.Caxis` + color + Sets default for all colors associated with this axis + all at once: line, font, tick, and grid colors. Grid + color is lightened by blending this with the plot + background Individual pieces can override this. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + hoverformat + Sets the hover text formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + layer + Sets the layer on which this axis is displayed. If + *above traces*, this axis is displayed above all the + subplot's traces If *below traces*, this axis is + displayed below all the subplot's traces, but above the + grid lines. Useful when used together with scatter-like + traces with `cliponaxis` set to False to show markers + and/or text nodes above this axis. + linecolor + Sets the axis line color. + linewidth + Sets the width (in px) of the axis line. + min + The minimum value visible on this axis. The maximum is + determined by the sum minus the minimum values of the + other two axes. The full view corresponds to all the + minima set to zero. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + showline + Determines whether or not a line bounding this axis is + drawn. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the tick font. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.layout.ternary. + caxis.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.layout.tern + ary.caxis.tickformatstopdefaults), sets the default + property values to use for elements of + layout.ternary.caxis.tickformatstops + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.layout.ternary.caxis.Title + ` instance or dict with compatible properties + uirevision + Controls persistence of user-driven changes in axis + `min`, and `title` if in `editable: true` + configuration. Defaults to `ternary.uirevision`. + + Returns + ------- + Caxis + """ + super().__init__("caxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.Caxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.Caxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("hoverformat", arg, hoverformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("layer", arg, layer) + self._set_property("linecolor", arg, linecolor) + self._set_property("linewidth", arg, linewidth) + self._set_property("min", arg, min) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showgrid", arg, showgrid) + self._set_property("showline", arg, showline) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("uirevision", arg, uirevision) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_domain.py new file mode 100644 index 0000000..ce72c0d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Domain(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary" + _path_str = "layout.ternary.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this ternary subplot . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this ternary subplot . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this ternary subplot (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this ternary subplot (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this ternary subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this ternary subplot . + x + Sets the horizontal domain of this ternary subplot (in + plot fraction). + y + Sets the vertical domain of this ternary subplot (in + plot fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this ternary subplot . + row + If there is a layout grid, use the domain for this row + in the grid for this ternary subplot . + x + Sets the horizontal domain of this ternary subplot (in + plot fraction). + y + Sets the vertical domain of this ternary subplot (in + plot fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py new file mode 100644 index 0000000..2da6f8a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.aaxis" + _path_str = "layout.ternary.aaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .aaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py new file mode 100644 index 0000000..e58ffb3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.aaxis" + _path_str = "layout.ternary.aaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .aaxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_title.py new file mode 100644 index 0000000..3e143c2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.aaxis" + _path_str = "layout.ternary.aaxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.aaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.aaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.aaxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/_font.py new file mode 100644 index 0000000..2f486ce --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/aaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.aaxis.title" + _path_str = "layout.ternary.aaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .aaxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.aaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.aaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickfont.py new file mode 100644 index 0000000..33d4488 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.baxis" + _path_str = "layout.ternary.baxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .baxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py new file mode 100644 index 0000000..7c934f9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.baxis" + _path_str = "layout.ternary.baxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .baxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_title.py new file mode 100644 index 0000000..e41f7fa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.baxis" + _path_str = "layout.ternary.baxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.baxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.baxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.baxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/_font.py new file mode 100644 index 0000000..596e1c7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/baxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.baxis.title" + _path_str = "layout.ternary.baxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .baxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.baxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.baxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickfont.py new file mode 100644 index 0000000..9e5adba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.caxis" + _path_str = "layout.ternary.caxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .caxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py new file mode 100644 index 0000000..a0baf4d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.caxis" + _path_str = "layout.ternary.caxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .caxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_title.py new file mode 100644 index 0000000..cdb9446 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/_title.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.caxis" + _path_str = "layout.ternary.caxis.title" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.ternary.caxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.ternary.caxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.ternary.caxis.Title` + font + Sets this axis' title font. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/_font.py new file mode 100644 index 0000000..c4868a7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/ternary/caxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.ternary.caxis.title" + _path_str = "layout.ternary.caxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.ternary + .caxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.ternary.caxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.ternary.caxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/__init__.py new file mode 100644 index 0000000..11f90e0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/__init__.py @@ -0,0 +1,14 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font + from ._pad import Pad + from ._subtitle import Subtitle + from . import subtitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".subtitle"], ["._font.Font", "._pad.Pad", "._subtitle.Subtitle"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_font.py new file mode 100644 index 0000000..969f70e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.title" + _path_str = "layout.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_pad.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_pad.py new file mode 100644 index 0000000..c70910c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_pad.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Pad(_BaseLayoutHierarchyType): + _parent_path_str = "layout.title" + _path_str = "layout.title.pad" + _valid_props = {"b", "l", "r", "t"} + + @property + def b(self): + """ + The amount of padding (in px) along the bottom of the + component. + + The 'b' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def l(self): + """ + The amount of padding (in px) on the left side of the + component. + + The 'l' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["l"] + + @l.setter + def l(self, val): + self["l"] = val + + @property + def r(self): + """ + The amount of padding (in px) on the right side of the + component. + + The 'r' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def t(self): + """ + The amount of padding (in px) along the top of the component. + + The 't' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["t"] + + @t.setter + def t(self, val): + self["t"] = val + + @property + def _prop_descriptions(self): + return """\ + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + """ + + def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): + """ + Construct a new Pad object + + Sets the padding of the title. Each padding value only applies + when the corresponding `xanchor`/`yanchor` value is set + accordingly. E.g. for left padding to take effect, `xanchor` + must be set to "left". The same rule applies if + `xanchor`/`yanchor` is determined automatically. Padding is + muted if the respective anchor value is "middle*/*center". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.title.Pad` + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + + Returns + ------- + Pad + """ + super().__init__("pad") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.title.Pad +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.title.Pad`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("b", arg, b) + self._set_property("l", arg, l) + self._set_property("r", arg, r) + self._set_property("t", arg, t) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_subtitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_subtitle.py new file mode 100644 index 0000000..fb36d65 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/_subtitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Subtitle(_BaseLayoutHierarchyType): + _parent_path_str = "layout.title" + _path_str = "layout.title.subtitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets the subtitle font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.title.subtitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.title.subtitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the plot's subtitle. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets the subtitle font. + text + Sets the plot's subtitle. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Subtitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.title.Subtitle` + font + Sets the subtitle font. + text + Sets the plot's subtitle. + + Returns + ------- + Subtitle + """ + super().__init__("subtitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.title.Subtitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.title.Subtitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/_font.py new file mode 100644 index 0000000..7e3781a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/title/subtitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.title.subtitle" + _path_str = "layout.title.subtitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the subtitle font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.title.subtitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.title.subtitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.title.subtitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/__init__.py new file mode 100644 index 0000000..f42482b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._button import Button + from ._font import Font + from ._pad import Pad +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._button.Button", "._font.Font", "._pad.Pad"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_button.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_button.py new file mode 100644 index 0000000..2fdb0b4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_button.py @@ -0,0 +1,359 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Button(_BaseLayoutHierarchyType): + _parent_path_str = "layout.updatemenu" + _path_str = "layout.updatemenu.button" + _valid_props = { + "args", + "args2", + "execute", + "label", + "method", + "name", + "templateitemname", + "visible", + } + + @property + def args(self): + """ + Sets the arguments values to be passed to the Plotly method set + in `method` on click. + + The 'args' property is an info array that may be specified as: + + * a list or tuple of up to 3 elements where: + (0) The 'args[0]' property accepts values of any type + (1) The 'args[1]' property accepts values of any type + (2) The 'args[2]' property accepts values of any type + + Returns + ------- + list + """ + return self["args"] + + @args.setter + def args(self, val): + self["args"] = val + + @property + def args2(self): + """ + Sets a 2nd set of `args`, these arguments values are passed to + the Plotly method set in `method` when clicking this button + while in the active state. Use this to create toggle buttons. + + The 'args2' property is an info array that may be specified as: + + * a list or tuple of up to 3 elements where: + (0) The 'args2[0]' property accepts values of any type + (1) The 'args2[1]' property accepts values of any type + (2) The 'args2[2]' property accepts values of any type + + Returns + ------- + list + """ + return self["args2"] + + @args2.setter + def args2(self, val): + self["args2"] = val + + @property + def execute(self): + """ + When true, the API method is executed. When false, all other + behaviors are the same and command execution is skipped. This + may be useful when hooking into, for example, the + `plotly_buttonclicked` method and executing the API command + manually without losing the benefit of the updatemenu + automatically binding to the state of the plot through the + specification of `method` and `args`. + + The 'execute' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["execute"] + + @execute.setter + def execute(self, val): + self["execute"] = val + + @property + def label(self): + """ + Sets the text label to appear on the button. + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def method(self): + """ + Sets the Plotly method to be called on click. If the `skip` + method is used, the API updatemenu will function as normal but + will perform no API calls and will not bind automatically to + state updates. This may be used to create a component interface + and attach to updatemenu events manually via JavaScript. + + The 'method' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['restyle', 'relayout', 'animate', 'update', 'skip'] + + Returns + ------- + Any + """ + return self["method"] + + @method.setter + def method(self, val): + self["method"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def visible(self): + """ + Determines whether or not this button is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + args + Sets the arguments values to be passed to the Plotly + method set in `method` on click. + args2 + Sets a 2nd set of `args`, these arguments values are + passed to the Plotly method set in `method` when + clicking this button while in the active state. Use + this to create toggle buttons. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_buttonclicked` method and + executing the API command manually without losing the + benefit of the updatemenu automatically binding to the + state of the plot through the specification of `method` + and `args`. + label + Sets the text label to appear on the button. + method + Sets the Plotly method to be called on click. If the + `skip` method is used, the API updatemenu will function + as normal but will perform no API calls and will not + bind automatically to state updates. This may be used + to create a component interface and attach to + updatemenu events manually via JavaScript. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + """ + + def __init__( + self, + arg=None, + args=None, + args2=None, + execute=None, + label=None, + method=None, + name=None, + templateitemname=None, + visible=None, + **kwargs, + ): + """ + Construct a new Button object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.updatemenu.Button` + args + Sets the arguments values to be passed to the Plotly + method set in `method` on click. + args2 + Sets a 2nd set of `args`, these arguments values are + passed to the Plotly method set in `method` when + clicking this button while in the active state. Use + this to create toggle buttons. + execute + When true, the API method is executed. When false, all + other behaviors are the same and command execution is + skipped. This may be useful when hooking into, for + example, the `plotly_buttonclicked` method and + executing the API command manually without losing the + benefit of the updatemenu automatically binding to the + state of the plot through the specification of `method` + and `args`. + label + Sets the text label to appear on the button. + method + Sets the Plotly method to be called on click. If the + `skip` method is used, the API updatemenu will function + as normal but will perform no API calls and will not + bind automatically to state updates. This may be used + to create a component interface and attach to + updatemenu events manually via JavaScript. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + + Returns + ------- + Button + """ + super().__init__("buttons") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.updatemenu.Button +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.updatemenu.Button`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("args", arg, args) + self._set_property("args2", arg, args2) + self._set_property("execute", arg, execute) + self._set_property("label", arg, label) + self._set_property("method", arg, method) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_font.py new file mode 100644 index 0000000..cbab80e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.updatemenu" + _path_str = "layout.updatemenu.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font of the update menu button text. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.updatemenu.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.updatemenu.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.updatemenu.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_pad.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_pad.py new file mode 100644 index 0000000..3a641d8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/updatemenu/_pad.py @@ -0,0 +1,159 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Pad(_BaseLayoutHierarchyType): + _parent_path_str = "layout.updatemenu" + _path_str = "layout.updatemenu.pad" + _valid_props = {"b", "l", "r", "t"} + + @property + def b(self): + """ + The amount of padding (in px) along the bottom of the + component. + + The 'b' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def l(self): + """ + The amount of padding (in px) on the left side of the + component. + + The 'l' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["l"] + + @l.setter + def l(self, val): + self["l"] = val + + @property + def r(self): + """ + The amount of padding (in px) on the right side of the + component. + + The 'r' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def t(self): + """ + The amount of padding (in px) along the top of the component. + + The 't' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["t"] + + @t.setter + def t(self, val): + self["t"] = val + + @property + def _prop_descriptions(self): + return """\ + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + """ + + def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): + """ + Construct a new Pad object + + Sets the padding around the buttons or dropdown menu. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.updatemenu.Pad` + b + The amount of padding (in px) along the bottom of the + component. + l + The amount of padding (in px) on the left side of the + component. + r + The amount of padding (in px) on the right side of the + component. + t + The amount of padding (in px) along the top of the + component. + + Returns + ------- + Pad + """ + super().__init__("pad") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.updatemenu.Pad +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.updatemenu.Pad`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("b", arg, b) + self._set_property("l", arg, l) + self._set_property("r", arg, r) + self._set_property("t", arg, t) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/__init__.py new file mode 100644 index 0000000..92c3b60 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/__init__.py @@ -0,0 +1,32 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._autorangeoptions import Autorangeoptions + from ._minor import Minor + from ._rangebreak import Rangebreak + from ._rangeselector import Rangeselector + from ._rangeslider import Rangeslider + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import rangeselector + from . import rangeslider + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".rangeselector", ".rangeslider", ".title"], + [ + "._autorangeoptions.Autorangeoptions", + "._minor.Minor", + "._rangebreak.Rangebreak", + "._rangeselector.Rangeselector", + "._rangeslider.Rangeslider", + "._tickfont.Tickfont", + "._tickformatstop.Tickformatstop", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_autorangeoptions.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_autorangeoptions.py new file mode 100644 index 0000000..e16114b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_autorangeoptions.py @@ -0,0 +1,216 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Autorangeoptions(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.autorangeoptions" + _valid_props = { + "clipmax", + "clipmin", + "include", + "includesrc", + "maxallowed", + "minallowed", + } + + @property + def clipmax(self): + """ + Clip autorange maximum if it goes beyond this value. Has no + effect when `autorangeoptions.maxallowed` is provided. + + The 'clipmax' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmax"] + + @clipmax.setter + def clipmax(self, val): + self["clipmax"] = val + + @property + def clipmin(self): + """ + Clip autorange minimum if it goes beyond this value. Has no + effect when `autorangeoptions.minallowed` is provided. + + The 'clipmin' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmin"] + + @clipmin.setter + def clipmin(self, val): + self["clipmin"] = val + + @property + def include(self): + """ + Ensure this value is included in autorange. + + The 'include' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["include"] + + @include.setter + def include(self, val): + self["include"] = val + + @property + def includesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `include`. + + The 'includesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["includesrc"] + + @includesrc.setter + def includesrc(self, val): + self["includesrc"] = val + + @property + def maxallowed(self): + """ + Use this value exactly as autorange maximum. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Use this value exactly as autorange minimum. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def _prop_descriptions(self): + return """\ + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + """ + + def __init__( + self, + arg=None, + clipmax=None, + clipmin=None, + include=None, + includesrc=None, + maxallowed=None, + minallowed=None, + **kwargs, + ): + """ + Construct a new Autorangeoptions object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.xaxis.A + utorangeoptions` + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + + Returns + ------- + Autorangeoptions + """ + super().__init__("autorangeoptions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Autorangeoptions +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Autorangeoptions`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("clipmax", arg, clipmax) + self._set_property("clipmin", arg, clipmin) + self._set_property("include", arg, include) + self._set_property("includesrc", arg, includesrc) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_minor.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_minor.py new file mode 100644 index 0000000..fbe8b72 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_minor.py @@ -0,0 +1,566 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Minor(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.minor" + _valid_props = { + "dtick", + "gridcolor", + "griddash", + "gridwidth", + "nticks", + "showgrid", + "tick0", + "tickcolor", + "ticklen", + "tickmode", + "ticks", + "tickvals", + "tickvalssrc", + "tickwidth", + } + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickcolor + Sets the tick color. + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + """ + + def __init__( + self, + arg=None, + dtick=None, + gridcolor=None, + griddash=None, + gridwidth=None, + nticks=None, + showgrid=None, + tick0=None, + tickcolor=None, + ticklen=None, + tickmode=None, + ticks=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + **kwargs, + ): + """ + Construct a new Minor object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Minor` + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickcolor + Sets the tick color. + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + + Returns + ------- + Minor + """ + super().__init__("minor") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Minor +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Minor`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtick", arg, dtick) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("nticks", arg, nticks) + self._set_property("showgrid", arg, showgrid) + self._set_property("tick0", arg, tick0) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("ticks", arg, ticks) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangebreak.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangebreak.py new file mode 100644 index 0000000..40246fb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangebreak.py @@ -0,0 +1,330 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rangebreak(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.rangebreak" + _valid_props = { + "bounds", + "dvalue", + "enabled", + "name", + "pattern", + "templateitemname", + "values", + } + + @property + def bounds(self): + """ + Sets the lower and upper bounds of this axis rangebreak. Can be + used with `pattern`. + + The 'bounds' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'bounds[0]' property accepts values of any type + (1) The 'bounds[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["bounds"] + + @bounds.setter + def bounds(self, val): + self["bounds"] = val + + @property + def dvalue(self): + """ + Sets the size of each `values` item. The default is one day in + milliseconds. + + The 'dvalue' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["dvalue"] + + @dvalue.setter + def dvalue(self, val): + self["dvalue"] = val + + @property + def enabled(self): + """ + Determines whether this axis rangebreak is enabled or disabled. + Please note that `rangebreaks` only work for "date" axis type. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def pattern(self): + """ + Determines a pattern on the time line that generates breaks. If + *day of week* - days of the week in English e.g. 'Sunday' or + `sun` (matching is case-insensitive and considers only the + first three characters), as well as Sunday-based integers + between 0 and 6. If "hour" - hour (24-hour clock) as decimal + numbers between 0 and 24. for more info. Examples: - { pattern: + 'day of week', bounds: [6, 1] } or simply { bounds: ['sat', + 'mon'] } breaks from Saturday to Monday (i.e. skips the + weekends). - { pattern: 'hour', bounds: [17, 8] } breaks from + 5pm to 8am (i.e. skips non-work hours). + + The 'pattern' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['day of week', 'hour', ''] + + Returns + ------- + Any + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def values(self): + """ + Sets the coordinate values corresponding to the rangebreaks. An + alternative to `bounds`. Use `dvalue` to set the size of the + values along the axis. + + The 'values' property is an info array that may be specified as: + * a list of elements where: + The 'values[i]' property accepts values of any type + + Returns + ------- + list + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def _prop_descriptions(self): + return """\ + bounds + Sets the lower and upper bounds of this axis + rangebreak. Can be used with `pattern`. + dvalue + Sets the size of each `values` item. The default is one + day in milliseconds. + enabled + Determines whether this axis rangebreak is enabled or + disabled. Please note that `rangebreaks` only work for + "date" axis type. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pattern + Determines a pattern on the time line that generates + breaks. If *day of week* - days of the week in English + e.g. 'Sunday' or `sun` (matching is case-insensitive + and considers only the first three characters), as well + as Sunday-based integers between 0 and 6. If "hour" - + hour (24-hour clock) as decimal numbers between 0 and + 24. for more info. Examples: - { pattern: 'day of + week', bounds: [6, 1] } or simply { bounds: ['sat', + 'mon'] } breaks from Saturday to Monday (i.e. skips + the weekends). - { pattern: 'hour', bounds: [17, 8] } + breaks from 5pm to 8am (i.e. skips non-work hours). + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the coordinate values corresponding to the + rangebreaks. An alternative to `bounds`. Use `dvalue` + to set the size of the values along the axis. + """ + + def __init__( + self, + arg=None, + bounds=None, + dvalue=None, + enabled=None, + name=None, + pattern=None, + templateitemname=None, + values=None, + **kwargs, + ): + """ + Construct a new Rangebreak object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Rangebreak` + bounds + Sets the lower and upper bounds of this axis + rangebreak. Can be used with `pattern`. + dvalue + Sets the size of each `values` item. The default is one + day in milliseconds. + enabled + Determines whether this axis rangebreak is enabled or + disabled. Please note that `rangebreaks` only work for + "date" axis type. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pattern + Determines a pattern on the time line that generates + breaks. If *day of week* - days of the week in English + e.g. 'Sunday' or `sun` (matching is case-insensitive + and considers only the first three characters), as well + as Sunday-based integers between 0 and 6. If "hour" - + hour (24-hour clock) as decimal numbers between 0 and + 24. for more info. Examples: - { pattern: 'day of + week', bounds: [6, 1] } or simply { bounds: ['sat', + 'mon'] } breaks from Saturday to Monday (i.e. skips + the weekends). - { pattern: 'hour', bounds: [17, 8] } + breaks from 5pm to 8am (i.e. skips non-work hours). + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the coordinate values corresponding to the + rangebreaks. An alternative to `bounds`. Use `dvalue` + to set the size of the values along the axis. + + Returns + ------- + Rangebreak + """ + super().__init__("rangebreaks") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Rangebreak +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Rangebreak`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bounds", arg, bounds) + self._set_property("dvalue", arg, dvalue) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("pattern", arg, pattern) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("values", arg, values) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeselector.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeselector.py new file mode 100644 index 0000000..22404bc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeselector.py @@ -0,0 +1,427 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rangeselector(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.rangeselector" + _valid_props = { + "activecolor", + "bgcolor", + "bordercolor", + "borderwidth", + "buttondefaults", + "buttons", + "font", + "visible", + "x", + "xanchor", + "y", + "yanchor", + } + + @property + def activecolor(self): + """ + Sets the background color of the active range selector button. + + The 'activecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["activecolor"] + + @activecolor.setter + def activecolor(self, val): + self["activecolor"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the range selector buttons. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the color of the border enclosing the range selector. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) of the border enclosing the range + selector. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def buttons(self): + """ + Sets the specifications for each buttons. By default, a range + selector comes with no buttons. + + The 'buttons' property is a tuple of instances of + Button that may be specified as: + - A list or tuple of instances of plotly.graph_objs.layout.xaxis.rangeselector.Button + - A list or tuple of dicts of string/value properties that + will be passed to the Button constructor + + Returns + ------- + tuple[plotly.graph_objs.layout.xaxis.rangeselector.Button] + """ + return self["buttons"] + + @buttons.setter + def buttons(self, val): + self["buttons"] = val + + @property + def buttondefaults(self): + """ + When used in a template (as + layout.template.layout.xaxis.rangeselector.buttondefaults), + sets the default property values to use for elements of + layout.xaxis.rangeselector.buttons + + The 'buttondefaults' property is an instance of Button + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Button` + - A dict of string/value properties that will be passed + to the Button constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.rangeselector.Button + """ + return self["buttondefaults"] + + @buttondefaults.setter + def buttondefaults(self, val): + self["buttondefaults"] = val + + @property + def font(self): + """ + Sets the font of the range selector button text. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.rangeselector.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def visible(self): + """ + Determines whether or not this range selector is visible. Note + that range selectors are only available for x axes of `type` + set to or auto-typed to "date". + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def x(self): + """ + Sets the x position (in normalized coordinates) of the range + selector. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets the range selector's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" or + "right" of the range selector. + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def y(self): + """ + Sets the y position (in normalized coordinates) of the range + selector. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-2, 3] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets the range selector's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the range selector. + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def _prop_descriptions(self): + return """\ + activecolor + Sets the background color of the active range selector + button. + bgcolor + Sets the background color of the range selector + buttons. + bordercolor + Sets the color of the border enclosing the range + selector. + borderwidth + Sets the width (in px) of the border enclosing the + range selector. + buttons + Sets the specifications for each buttons. By default, a + range selector comes with no buttons. + buttondefaults + When used in a template (as layout.template.layout.xaxi + s.rangeselector.buttondefaults), sets the default + property values to use for elements of + layout.xaxis.rangeselector.buttons + font + Sets the font of the range selector button text. + visible + Determines whether or not this range selector is + visible. Note that range selectors are only available + for x axes of `type` set to or auto-typed to "date". + x + Sets the x position (in normalized coordinates) of the + range selector. + xanchor + Sets the range selector's horizontal position anchor. + This anchor binds the `x` position to the "left", + "center" or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + range selector. + yanchor + Sets the range selector's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + """ + + def __init__( + self, + arg=None, + activecolor=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + buttons=None, + buttondefaults=None, + font=None, + visible=None, + x=None, + xanchor=None, + y=None, + yanchor=None, + **kwargs, + ): + """ + Construct a new Rangeselector object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Rangeselector` + activecolor + Sets the background color of the active range selector + button. + bgcolor + Sets the background color of the range selector + buttons. + bordercolor + Sets the color of the border enclosing the range + selector. + borderwidth + Sets the width (in px) of the border enclosing the + range selector. + buttons + Sets the specifications for each buttons. By default, a + range selector comes with no buttons. + buttondefaults + When used in a template (as layout.template.layout.xaxi + s.rangeselector.buttondefaults), sets the default + property values to use for elements of + layout.xaxis.rangeselector.buttons + font + Sets the font of the range selector button text. + visible + Determines whether or not this range selector is + visible. Note that range selectors are only available + for x axes of `type` set to or auto-typed to "date". + x + Sets the x position (in normalized coordinates) of the + range selector. + xanchor + Sets the range selector's horizontal position anchor. + This anchor binds the `x` position to the "left", + "center" or "right" of the range selector. + y + Sets the y position (in normalized coordinates) of the + range selector. + yanchor + Sets the range selector's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the range selector. + + Returns + ------- + Rangeselector + """ + super().__init__("rangeselector") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Rangeselector +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Rangeselector`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("activecolor", arg, activecolor) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("buttons", arg, buttons) + self._set_property("buttondefaults", arg, buttondefaults) + self._set_property("font", arg, font) + self._set_property("visible", arg, visible) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeslider.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeslider.py new file mode 100644 index 0000000..9d30a4d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_rangeslider.py @@ -0,0 +1,311 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rangeslider(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.rangeslider" + _valid_props = { + "autorange", + "bgcolor", + "bordercolor", + "borderwidth", + "range", + "thickness", + "visible", + "yaxis", + } + + @property + def autorange(self): + """ + Determines whether or not the range slider range is computed in + relation to the input data. If `range` is provided, then + `autorange` is set to False. + + The 'autorange' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autorange"] + + @autorange.setter + def autorange(self, val): + self["autorange"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the range slider. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the range slider. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the border width of the range slider. + + The 'borderwidth' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def range(self): + """ + Sets the range of the range slider. If not set, defaults to the + full xaxis range. If the axis `type` is "log", then you must + take the log of your desired range. If the axis `type` is + "date", it should be date strings, like date data, though Date + objects and unix milliseconds will be accepted and converted to + strings. If the axis `type` is "category", it should be + numbers, using the scale where each category is assigned a + serial number from zero in the order it appears. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def thickness(self): + """ + The height of the range slider as a fraction of the total plot + area height. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def visible(self): + """ + Determines whether or not the range slider will be visible. If + visible, perpendicular axes will be set to `fixedrange` + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def yaxis(self): + """ + The 'yaxis' property is an instance of YAxis + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.rangeslider.YAxis` + - A dict of string/value properties that will be passed + to the YAxis constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.rangeslider.YAxis + """ + return self["yaxis"] + + @yaxis.setter + def yaxis(self, val): + self["yaxis"] = val + + @property + def _prop_descriptions(self): + return """\ + autorange + Determines whether or not the range slider range is + computed in relation to the input data. If `range` is + provided, then `autorange` is set to False. + bgcolor + Sets the background color of the range slider. + bordercolor + Sets the border color of the range slider. + borderwidth + Sets the border width of the range slider. + range + Sets the range of the range slider. If not set, + defaults to the full xaxis range. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + thickness + The height of the range slider as a fraction of the + total plot area height. + visible + Determines whether or not the range slider will be + visible. If visible, perpendicular axes will be set to + `fixedrange` + yaxis + :class:`plotly.graph_objects.layout.xaxis.rangeslider.Y + Axis` instance or dict with compatible properties + """ + + def __init__( + self, + arg=None, + autorange=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + range=None, + thickness=None, + visible=None, + yaxis=None, + **kwargs, + ): + """ + Construct a new Rangeslider object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Rangeslider` + autorange + Determines whether or not the range slider range is + computed in relation to the input data. If `range` is + provided, then `autorange` is set to False. + bgcolor + Sets the background color of the range slider. + bordercolor + Sets the border color of the range slider. + borderwidth + Sets the border width of the range slider. + range + Sets the range of the range slider. If not set, + defaults to the full xaxis range. If the axis `type` is + "log", then you must take the log of your desired + range. If the axis `type` is "date", it should be date + strings, like date data, though Date objects and unix + milliseconds will be accepted and converted to strings. + If the axis `type` is "category", it should be numbers, + using the scale where each category is assigned a + serial number from zero in the order it appears. + thickness + The height of the range slider as a fraction of the + total plot area height. + visible + Determines whether or not the range slider will be + visible. If visible, perpendicular axes will be set to + `fixedrange` + yaxis + :class:`plotly.graph_objects.layout.xaxis.rangeslider.Y + Axis` instance or dict with compatible properties + + Returns + ------- + Rangeslider + """ + super().__init__("rangeslider") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Rangeslider +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Rangeslider`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autorange", arg, autorange) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("range", arg, range) + self._set_property("thickness", arg, thickness) + self._set_property("visible", arg, visible) + self._set_property("yaxis", arg, yaxis) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickfont.py new file mode 100644 index 0000000..3df643e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickformatstop.py new file mode 100644 index 0000000..6941096 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_title.py new file mode 100644 index 0000000..a517a22 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/_title.py @@ -0,0 +1,150 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis" + _path_str = "layout.xaxis.title" + _valid_props = {"font", "standoff", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.xaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.xaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def standoff(self): + """ + Sets the standoff distance (in px) between the axis labels and + the title text The default value is a function of the axis tick + labels, the title `font.size` and the axis `linewidth`. Note + that the axis title position is always constrained within the + margins, so the actual standoff distance is always less than + the set or default value. By setting `standoff` and turning on + `automargin`, plotly.js will push the margins to fit the axis + title at given standoff distance. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + standoff + Sets the standoff distance (in px) between the axis + labels and the title text The default value is a + function of the axis tick labels, the title `font.size` + and the axis `linewidth`. Note that the axis title + position is always constrained within the margins, so + the actual standoff distance is always less than the + set or default value. By setting `standoff` and turning + on `automargin`, plotly.js will push the margins to fit + the axis title at given standoff distance. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.Title` + font + Sets this axis' title font. + standoff + Sets the standoff distance (in px) between the axis + labels and the title text The default value is a + function of the axis tick labels, the title `font.size` + and the axis `linewidth`. Note that the axis title + position is always constrained within the margins, so + the actual standoff distance is always less than the + set or default value. By setting `standoff` and turning + on `automargin`, plotly.js will push the margins to fit + the axis title at given standoff distance. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("standoff", arg, standoff) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py new file mode 100644 index 0000000..4796cc0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._button import Button + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._button.Button", "._font.Font"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_button.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_button.py new file mode 100644 index 0000000..adfa467 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_button.py @@ -0,0 +1,318 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Button(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis.rangeselector" + _path_str = "layout.xaxis.rangeselector.button" + _valid_props = { + "count", + "label", + "name", + "step", + "stepmode", + "templateitemname", + "visible", + } + + @property + def count(self): + """ + Sets the number of steps to take to update the range. Use with + `step` to specify the update interval. + + The 'count' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["count"] + + @count.setter + def count(self, val): + self["count"] = val + + @property + def label(self): + """ + Sets the text label to appear on the button. + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def step(self): + """ + The unit of measurement that the `count` value will set the + range by. + + The 'step' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['month', 'year', 'day', 'hour', 'minute', 'second', + 'all'] + + Returns + ------- + Any + """ + return self["step"] + + @step.setter + def step(self, val): + self["step"] = val + + @property + def stepmode(self): + """ + Sets the range update mode. If "backward", the range update + shifts the start of range back "count" times "step" + milliseconds. If "todate", the range update shifts the start of + range back to the first timestamp from "count" times "step" + milliseconds back. For example, with `step` set to "year" and + `count` set to 1 the range update shifts the start of the range + back to January 01 of the current year. Month and year "todate" + are currently available only for the built-in (Gregorian) + calendar. + + The 'stepmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['backward', 'todate'] + + Returns + ------- + Any + """ + return self["stepmode"] + + @stepmode.setter + def stepmode(self, val): + self["stepmode"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def visible(self): + """ + Determines whether or not this button is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + count + Sets the number of steps to take to update the range. + Use with `step` to specify the update interval. + label + Sets the text label to appear on the button. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + step + The unit of measurement that the `count` value will set + the range by. + stepmode + Sets the range update mode. If "backward", the range + update shifts the start of range back "count" times + "step" milliseconds. If "todate", the range update + shifts the start of range back to the first timestamp + from "count" times "step" milliseconds back. For + example, with `step` set to "year" and `count` set to 1 + the range update shifts the start of the range back to + January 01 of the current year. Month and year "todate" + are currently available only for the built-in + (Gregorian) calendar. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + """ + + def __init__( + self, + arg=None, + count=None, + label=None, + name=None, + step=None, + stepmode=None, + templateitemname=None, + visible=None, + **kwargs, + ): + """ + Construct a new Button object + + Sets the specifications for each buttons. By default, a range + selector comes with no buttons. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.xaxis.r + angeselector.Button` + count + Sets the number of steps to take to update the range. + Use with `step` to specify the update interval. + label + Sets the text label to appear on the button. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + step + The unit of measurement that the `count` value will set + the range by. + stepmode + Sets the range update mode. If "backward", the range + update shifts the start of range back "count" times + "step" milliseconds. If "todate", the range update + shifts the start of range back to the first timestamp + from "count" times "step" milliseconds back. For + example, with `step` set to "year" and `count` set to 1 + the range update shifts the start of the range back to + January 01 of the current year. Month and year "todate" + are currently available only for the built-in + (Gregorian) calendar. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + visible + Determines whether or not this button is visible. + + Returns + ------- + Button + """ + super().__init__("buttons") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Button +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Button`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("count", arg, count) + self._set_property("label", arg, label) + self._set_property("name", arg, name) + self._set_property("step", arg, step) + self._set_property("stepmode", arg, stepmode) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_font.py new file mode 100644 index 0000000..b594067 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeselector/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis.rangeselector" + _path_str = "layout.xaxis.rangeselector.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font of the range selector button text. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.xaxis.r + angeselector.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.rangeselector.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.rangeselector.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py new file mode 100644 index 0000000..b48657f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._yaxis import YAxis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._yaxis.YAxis"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py new file mode 100644 index 0000000..1ce88a5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/rangeslider/_yaxis.py @@ -0,0 +1,118 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class YAxis(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis.rangeslider" + _path_str = "layout.xaxis.rangeslider.yaxis" + _valid_props = {"range", "rangemode"} + + @property + def range(self): + """ + Sets the range of this axis for the rangeslider. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property accepts values of any type + (1) The 'range[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def rangemode(self): + """ + Determines whether or not the range of this axis in the + rangeslider use the same value than in the main plot when + zooming in/out. If "auto", the autorange will be used. If + "fixed", the `range` is used. If "match", the current range of + the corresponding y-axis on the main subplot is used. + + The 'rangemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'fixed', 'match'] + + Returns + ------- + Any + """ + return self["rangemode"] + + @rangemode.setter + def rangemode(self, val): + self["rangemode"] = val + + @property + def _prop_descriptions(self): + return """\ + range + Sets the range of this axis for the rangeslider. + rangemode + Determines whether or not the range of this axis in the + rangeslider use the same value than in the main plot + when zooming in/out. If "auto", the autorange will be + used. If "fixed", the `range` is used. If "match", the + current range of the corresponding y-axis on the main + subplot is used. + """ + + def __init__(self, arg=None, range=None, rangemode=None, **kwargs): + """ + Construct a new YAxis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.xaxis.r + angeslider.YAxis` + range + Sets the range of this axis for the rangeslider. + rangemode + Determines whether or not the range of this axis in the + rangeslider use the same value than in the main plot + when zooming in/out. If "auto", the autorange will be + used. If "fixed", the `range` is used. If "match", the + current range of the corresponding y-axis on the main + subplot is used. + + Returns + ------- + YAxis + """ + super().__init__("yaxis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.rangeslider.YAxis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.rangeslider.YAxis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("range", arg, range) + self._set_property("rangemode", arg, rangemode) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/_font.py new file mode 100644 index 0000000..b943351 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/xaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.xaxis.title" + _path_str = "layout.xaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.xaxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.xaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.xaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/__init__.py new file mode 100644 index 0000000..7d5e696 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/__init__.py @@ -0,0 +1,26 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._autorangeoptions import Autorangeoptions + from ._minor import Minor + from ._rangebreak import Rangebreak + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + [ + "._autorangeoptions.Autorangeoptions", + "._minor.Minor", + "._rangebreak.Rangebreak", + "._tickfont.Tickfont", + "._tickformatstop.Tickformatstop", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_autorangeoptions.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_autorangeoptions.py new file mode 100644 index 0000000..722feb1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_autorangeoptions.py @@ -0,0 +1,216 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Autorangeoptions(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis" + _path_str = "layout.yaxis.autorangeoptions" + _valid_props = { + "clipmax", + "clipmin", + "include", + "includesrc", + "maxallowed", + "minallowed", + } + + @property + def clipmax(self): + """ + Clip autorange maximum if it goes beyond this value. Has no + effect when `autorangeoptions.maxallowed` is provided. + + The 'clipmax' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmax"] + + @clipmax.setter + def clipmax(self, val): + self["clipmax"] = val + + @property + def clipmin(self): + """ + Clip autorange minimum if it goes beyond this value. Has no + effect when `autorangeoptions.minallowed` is provided. + + The 'clipmin' property accepts values of any type + + Returns + ------- + Any + """ + return self["clipmin"] + + @clipmin.setter + def clipmin(self, val): + self["clipmin"] = val + + @property + def include(self): + """ + Ensure this value is included in autorange. + + The 'include' property accepts values of any type + + Returns + ------- + Any|numpy.ndarray + """ + return self["include"] + + @include.setter + def include(self, val): + self["include"] = val + + @property + def includesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `include`. + + The 'includesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["includesrc"] + + @includesrc.setter + def includesrc(self, val): + self["includesrc"] = val + + @property + def maxallowed(self): + """ + Use this value exactly as autorange maximum. + + The 'maxallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["maxallowed"] + + @maxallowed.setter + def maxallowed(self, val): + self["maxallowed"] = val + + @property + def minallowed(self): + """ + Use this value exactly as autorange minimum. + + The 'minallowed' property accepts values of any type + + Returns + ------- + Any + """ + return self["minallowed"] + + @minallowed.setter + def minallowed(self, val): + self["minallowed"] = val + + @property + def _prop_descriptions(self): + return """\ + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + """ + + def __init__( + self, + arg=None, + clipmax=None, + clipmin=None, + include=None, + includesrc=None, + maxallowed=None, + minallowed=None, + **kwargs, + ): + """ + Construct a new Autorangeoptions object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.layout.yaxis.A + utorangeoptions` + clipmax + Clip autorange maximum if it goes beyond this value. + Has no effect when `autorangeoptions.maxallowed` is + provided. + clipmin + Clip autorange minimum if it goes beyond this value. + Has no effect when `autorangeoptions.minallowed` is + provided. + include + Ensure this value is included in autorange. + includesrc + Sets the source reference on Chart Studio Cloud for + `include`. + maxallowed + Use this value exactly as autorange maximum. + minallowed + Use this value exactly as autorange minimum. + + Returns + ------- + Autorangeoptions + """ + super().__init__("autorangeoptions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.Autorangeoptions +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.Autorangeoptions`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("clipmax", arg, clipmax) + self._set_property("clipmin", arg, clipmin) + self._set_property("include", arg, include) + self._set_property("includesrc", arg, includesrc) + self._set_property("maxallowed", arg, maxallowed) + self._set_property("minallowed", arg, minallowed) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_minor.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_minor.py new file mode 100644 index 0000000..c718a60 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_minor.py @@ -0,0 +1,566 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Minor(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis" + _path_str = "layout.yaxis.minor" + _valid_props = { + "dtick", + "gridcolor", + "griddash", + "gridwidth", + "nticks", + "showgrid", + "tick0", + "tickcolor", + "ticklen", + "tickmode", + "ticks", + "tickvals", + "tickvalssrc", + "tickwidth", + } + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def gridcolor(self): + """ + Sets the color of the grid lines. + + The 'gridcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["gridcolor"] + + @gridcolor.setter + def gridcolor(self, val): + self["gridcolor"] = val + + @property + def griddash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'griddash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["griddash"] + + @griddash.setter + def griddash(self, val): + self["griddash"] = val + + @property + def gridwidth(self): + """ + Sets the width (in px) of the grid lines. + + The 'gridwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["gridwidth"] + + @gridwidth.setter + def gridwidth(self, val): + self["gridwidth"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def showgrid(self): + """ + Determines whether or not grid lines are drawn. If True, the + grid lines are drawn at every tick mark. + + The 'showgrid' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showgrid"] + + @showgrid.setter + def showgrid(self, val): + self["showgrid"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def _prop_descriptions(self): + return """\ + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickcolor + Sets the tick color. + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + """ + + def __init__( + self, + arg=None, + dtick=None, + gridcolor=None, + griddash=None, + gridwidth=None, + nticks=None, + showgrid=None, + tick0=None, + tickcolor=None, + ticklen=None, + tickmode=None, + ticks=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + **kwargs, + ): + """ + Construct a new Minor object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.yaxis.Minor` + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + gridcolor + Sets the color of the grid lines. + griddash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + gridwidth + Sets the width (in px) of the grid lines. + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + showgrid + Determines whether or not grid lines are drawn. If + True, the grid lines are drawn at every tick mark. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickcolor + Sets the tick color. + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + + Returns + ------- + Minor + """ + super().__init__("minor") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.Minor +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.Minor`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtick", arg, dtick) + self._set_property("gridcolor", arg, gridcolor) + self._set_property("griddash", arg, griddash) + self._set_property("gridwidth", arg, gridwidth) + self._set_property("nticks", arg, nticks) + self._set_property("showgrid", arg, showgrid) + self._set_property("tick0", arg, tick0) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("ticks", arg, ticks) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_rangebreak.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_rangebreak.py new file mode 100644 index 0000000..1816985 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_rangebreak.py @@ -0,0 +1,330 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Rangebreak(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis" + _path_str = "layout.yaxis.rangebreak" + _valid_props = { + "bounds", + "dvalue", + "enabled", + "name", + "pattern", + "templateitemname", + "values", + } + + @property + def bounds(self): + """ + Sets the lower and upper bounds of this axis rangebreak. Can be + used with `pattern`. + + The 'bounds' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'bounds[0]' property accepts values of any type + (1) The 'bounds[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["bounds"] + + @bounds.setter + def bounds(self, val): + self["bounds"] = val + + @property + def dvalue(self): + """ + Sets the size of each `values` item. The default is one day in + milliseconds. + + The 'dvalue' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["dvalue"] + + @dvalue.setter + def dvalue(self, val): + self["dvalue"] = val + + @property + def enabled(self): + """ + Determines whether this axis rangebreak is enabled or disabled. + Please note that `rangebreaks` only work for "date" axis type. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def pattern(self): + """ + Determines a pattern on the time line that generates breaks. If + *day of week* - days of the week in English e.g. 'Sunday' or + `sun` (matching is case-insensitive and considers only the + first three characters), as well as Sunday-based integers + between 0 and 6. If "hour" - hour (24-hour clock) as decimal + numbers between 0 and 24. for more info. Examples: - { pattern: + 'day of week', bounds: [6, 1] } or simply { bounds: ['sat', + 'mon'] } breaks from Saturday to Monday (i.e. skips the + weekends). - { pattern: 'hour', bounds: [17, 8] } breaks from + 5pm to 8am (i.e. skips non-work hours). + + The 'pattern' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['day of week', 'hour', ''] + + Returns + ------- + Any + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def values(self): + """ + Sets the coordinate values corresponding to the rangebreaks. An + alternative to `bounds`. Use `dvalue` to set the size of the + values along the axis. + + The 'values' property is an info array that may be specified as: + * a list of elements where: + The 'values[i]' property accepts values of any type + + Returns + ------- + list + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def _prop_descriptions(self): + return """\ + bounds + Sets the lower and upper bounds of this axis + rangebreak. Can be used with `pattern`. + dvalue + Sets the size of each `values` item. The default is one + day in milliseconds. + enabled + Determines whether this axis rangebreak is enabled or + disabled. Please note that `rangebreaks` only work for + "date" axis type. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pattern + Determines a pattern on the time line that generates + breaks. If *day of week* - days of the week in English + e.g. 'Sunday' or `sun` (matching is case-insensitive + and considers only the first three characters), as well + as Sunday-based integers between 0 and 6. If "hour" - + hour (24-hour clock) as decimal numbers between 0 and + 24. for more info. Examples: - { pattern: 'day of + week', bounds: [6, 1] } or simply { bounds: ['sat', + 'mon'] } breaks from Saturday to Monday (i.e. skips + the weekends). - { pattern: 'hour', bounds: [17, 8] } + breaks from 5pm to 8am (i.e. skips non-work hours). + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the coordinate values corresponding to the + rangebreaks. An alternative to `bounds`. Use `dvalue` + to set the size of the values along the axis. + """ + + def __init__( + self, + arg=None, + bounds=None, + dvalue=None, + enabled=None, + name=None, + pattern=None, + templateitemname=None, + values=None, + **kwargs, + ): + """ + Construct a new Rangebreak object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.yaxis.Rangebreak` + bounds + Sets the lower and upper bounds of this axis + rangebreak. Can be used with `pattern`. + dvalue + Sets the size of each `values` item. The default is one + day in milliseconds. + enabled + Determines whether this axis rangebreak is enabled or + disabled. Please note that `rangebreaks` only work for + "date" axis type. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + pattern + Determines a pattern on the time line that generates + breaks. If *day of week* - days of the week in English + e.g. 'Sunday' or `sun` (matching is case-insensitive + and considers only the first three characters), as well + as Sunday-based integers between 0 and 6. If "hour" - + hour (24-hour clock) as decimal numbers between 0 and + 24. for more info. Examples: - { pattern: 'day of + week', bounds: [6, 1] } or simply { bounds: ['sat', + 'mon'] } breaks from Saturday to Monday (i.e. skips + the weekends). - { pattern: 'hour', bounds: [17, 8] } + breaks from 5pm to 8am (i.e. skips non-work hours). + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the coordinate values corresponding to the + rangebreaks. An alternative to `bounds`. Use `dvalue` + to set the size of the values along the axis. + + Returns + ------- + Rangebreak + """ + super().__init__("rangebreaks") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.Rangebreak +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.Rangebreak`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bounds", arg, bounds) + self._set_property("dvalue", arg, dvalue) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("pattern", arg, pattern) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("values", arg, values) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickfont.py new file mode 100644 index 0000000..7a57384 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickfont(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis" + _path_str = "layout.yaxis.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the tick font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.yaxis.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickformatstop.py new file mode 100644 index 0000000..40314fd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis" + _path_str = "layout.yaxis.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.yaxis.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_title.py new file mode 100644 index 0000000..4bb8d4f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/_title.py @@ -0,0 +1,150 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Title(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis" + _path_str = "layout.yaxis.title" + _valid_props = {"font", "standoff", "text"} + + @property + def font(self): + """ + Sets this axis' title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.layout.yaxis.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.layout.yaxis.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def standoff(self): + """ + Sets the standoff distance (in px) between the axis labels and + the title text The default value is a function of the axis tick + labels, the title `font.size` and the axis `linewidth`. Note + that the axis title position is always constrained within the + margins, so the actual standoff distance is always less than + the set or default value. By setting `standoff` and turning on + `automargin`, plotly.js will push the margins to fit the axis + title at given standoff distance. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def text(self): + """ + Sets the title of this axis. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this axis' title font. + standoff + Sets the standoff distance (in px) between the axis + labels and the title text The default value is a + function of the axis tick labels, the title `font.size` + and the axis `linewidth`. Note that the axis title + position is always constrained within the margins, so + the actual standoff distance is always less than the + set or default value. By setting `standoff` and turning + on `automargin`, plotly.js will push the margins to fit + the axis title at given standoff distance. + text + Sets the title of this axis. + """ + + def __init__(self, arg=None, font=None, standoff=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.yaxis.Title` + font + Sets this axis' title font. + standoff + Sets the standoff distance (in px) between the axis + labels and the title text The default value is a + function of the axis tick labels, the title `font.size` + and the axis `linewidth`. Note that the axis title + position is always constrained within the margins, so + the actual standoff distance is always less than the + set or default value. By setting `standoff` and turning + on `automargin`, plotly.js will push the margins to fit + the axis title at given standoff distance. + text + Sets the title of this axis. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("standoff", arg, standoff) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/_font.py new file mode 100644 index 0000000..b04cd98 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/layout/yaxis/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseLayoutHierarchyType as _BaseLayoutHierarchyType +import copy as _copy + + +class Font(_BaseLayoutHierarchyType): + _parent_path_str = "layout.yaxis.title" + _path_str = "layout.yaxis.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this axis' title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.layout.yaxis.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.layout.yaxis.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.layout.yaxis.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/__init__.py new file mode 100644 index 0000000..b818b1a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/__init__.py @@ -0,0 +1,30 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._contour import Contour + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._lighting import Lighting + from ._lightposition import Lightposition + from ._stream import Stream + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._contour.Contour", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._lighting.Lighting", + "._lightposition.Lightposition", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_colorbar.py new file mode 100644 index 0000000..6e23c41 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.mesh3d.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.mesh3d.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.mesh3d.colorbar.tickformatstopdefaults), + sets the default property values to use for elements of + mesh3d.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.mesh3d.colorbar + .Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.mesh3d + .colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + mesh3d.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.mesh3d.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.mesh3d.colorbar + .Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.mesh3d + .colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + mesh3d.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.mesh3d.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_contour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_contour.py new file mode 100644 index 0000000..b55625a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_contour.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contour(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.contour" + _valid_props = {"color", "show", "width"} + + @property + def color(self): + """ + Sets the color of the contour lines. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def show(self): + """ + Sets whether or not dynamic contours are shown on hover + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def width(self): + """ + Sets the width of the contour lines. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + """ + + def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): + """ + Construct a new Contour object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.Contour` + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + + Returns + ------- + Contour + """ + super().__init__("contour") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.Contour +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.Contour`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("show", arg, show) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_hoverlabel.py new file mode 100644 index 0000000..dfcd90c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.mesh3d.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_legendgrouptitle.py new file mode 100644 index 0000000..19ae382 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.mesh3d.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lighting.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lighting.py new file mode 100644 index 0000000..18a57ff --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lighting.py @@ -0,0 +1,260 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.lighting" + _valid_props = { + "ambient", + "diffuse", + "facenormalsepsilon", + "fresnel", + "roughness", + "specular", + "vertexnormalsepsilon", + } + + @property + def ambient(self): + """ + Ambient light increases overall color visibility but can wash + out the image. + + The 'ambient' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ambient"] + + @ambient.setter + def ambient(self, val): + self["ambient"] = val + + @property + def diffuse(self): + """ + Represents the extent that incident rays are reflected in a + range of angles. + + The 'diffuse' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["diffuse"] + + @diffuse.setter + def diffuse(self, val): + self["diffuse"] = val + + @property + def facenormalsepsilon(self): + """ + Epsilon for face normals calculation avoids math issues arising + from degenerate geometry. + + The 'facenormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["facenormalsepsilon"] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self["facenormalsepsilon"] = val + + @property + def fresnel(self): + """ + Represents the reflectance as a dependency of the viewing + angle; e.g. paper is reflective when viewing it from the edge + of the paper (almost 90 degrees), causing shine. + + The 'fresnel' property is a number and may be specified as: + - An int or float in the interval [0, 5] + + Returns + ------- + int|float + """ + return self["fresnel"] + + @fresnel.setter + def fresnel(self, val): + self["fresnel"] = val + + @property + def roughness(self): + """ + Alters specular reflection; the rougher the surface, the wider + and less contrasty the shine. + + The 'roughness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["roughness"] + + @roughness.setter + def roughness(self, val): + self["roughness"] = val + + @property + def specular(self): + """ + Represents the level that incident rays are reflected in a + single direction, causing shine. + + The 'specular' property is a number and may be specified as: + - An int or float in the interval [0, 2] + + Returns + ------- + int|float + """ + return self["specular"] + + @specular.setter + def specular(self, val): + self["specular"] = val + + @property + def vertexnormalsepsilon(self): + """ + Epsilon for vertex normals calculation avoids math issues + arising from degenerate geometry. + + The 'vertexnormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["vertexnormalsepsilon"] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self["vertexnormalsepsilon"] = val + + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs, + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.Lighting` + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super().__init__("lighting") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.Lighting +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.Lighting`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("ambient", arg, ambient) + self._set_property("diffuse", arg, diffuse) + self._set_property("facenormalsepsilon", arg, facenormalsepsilon) + self._set_property("fresnel", arg, fresnel) + self._set_property("roughness", arg, roughness) + self._set_property("specular", arg, specular) + self._set_property("vertexnormalsepsilon", arg, vertexnormalsepsilon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lightposition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lightposition.py new file mode 100644 index 0000000..00b35d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_lightposition.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.lightposition" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Numeric vector, representing the X coordinate for each vertex. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Numeric vector, representing the Y coordinate for each vertex. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Numeric vector, representing the Z coordinate for each vertex. + + The 'z' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.Lightposition` + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super().__init__("lightposition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.Lightposition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.Lightposition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_stream.py new file mode 100644 index 0000000..b3b00d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d" + _path_str = "mesh3d.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.mesh3d.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickfont.py new file mode 100644 index 0000000..7aaacd1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d.colorbar" + _path_str = "mesh3d.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py new file mode 100644 index 0000000..bb5fe24 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d.colorbar" + _path_str = "mesh3d.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.mesh3d.colorba + r.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_title.py new file mode 100644 index 0000000..19426d4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d.colorbar" + _path_str = "mesh3d.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.mesh3d.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.mesh3d.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/_font.py new file mode 100644 index 0000000..f4dd6a9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d.colorbar.title" + _path_str = "mesh3d.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/_font.py new file mode 100644 index 0000000..0928833 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d.hoverlabel" + _path_str = "mesh3d.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/_font.py new file mode 100644 index 0000000..266ef98 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/mesh3d/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "mesh3d.legendgrouptitle" + _path_str = "mesh3d.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.mesh3d.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.mesh3d.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.mesh3d.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/__init__.py new file mode 100644 index 0000000..464258c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/__init__.py @@ -0,0 +1,29 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._decreasing import Decreasing + from ._hoverlabel import Hoverlabel + from ._increasing import Increasing + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._stream import Stream + from . import decreasing + from . import hoverlabel + from . import increasing + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".decreasing", ".hoverlabel", ".increasing", ".legendgrouptitle"], + [ + "._decreasing.Decreasing", + "._hoverlabel.Hoverlabel", + "._increasing.Increasing", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_decreasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_decreasing.py new file mode 100644 index 0000000..bed4934 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_decreasing.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Decreasing(_BaseTraceHierarchyType): + _parent_path_str = "ohlc" + _path_str = "ohlc.decreasing" + _valid_props = {"line"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.decreasing.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.ohlc.decreasing.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.ohlc.decreasing.Line` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, line=None, **kwargs): + """ + Construct a new Decreasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.Decreasing` + line + :class:`plotly.graph_objects.ohlc.decreasing.Line` + instance or dict with compatible properties + + Returns + ------- + Decreasing + """ + super().__init__("decreasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.Decreasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.Decreasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_hoverlabel.py new file mode 100644 index 0000000..8e0c8eb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_hoverlabel.py @@ -0,0 +1,366 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "ohlc" + _path_str = "ohlc.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + "split", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.ohlc.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def split(self): + """ + Show hover information (open, close, high, low) in separate + labels. + + The 'split' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["split"] + + @split.setter + def split(self, val): + self["split"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + split + Show hover information (open, close, high, low) in + separate labels. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + split=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + split + Show hover information (open, close, high, low) in + separate labels. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._set_property("split", arg, split) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_increasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_increasing.py new file mode 100644 index 0000000..77ff3e4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_increasing.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Increasing(_BaseTraceHierarchyType): + _parent_path_str = "ohlc" + _path_str = "ohlc.increasing" + _valid_props = {"line"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.increasing.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.ohlc.increasing.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.ohlc.increasing.Line` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, line=None, **kwargs): + """ + Construct a new Increasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.Increasing` + line + :class:`plotly.graph_objects.ohlc.increasing.Line` + instance or dict with compatible properties + + Returns + ------- + Increasing + """ + super().__init__("increasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.Increasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.Increasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_legendgrouptitle.py new file mode 100644 index 0000000..b21b440 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "ohlc" + _path_str = "ohlc.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.ohlc.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.ohlc.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_line.py new file mode 100644 index 0000000..0090896 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_line.py @@ -0,0 +1,123 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "ohlc" + _path_str = "ohlc.line" + _valid_props = {"dash", "width"} + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). Note that this style setting can also be + set per direction via `increasing.line.dash` and + `decreasing.line.dash`. + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + [object Object] Note that this style setting can also be set + per direction via `increasing.line.width` and + `decreasing.line.width`. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). Note that this style setting can + also be set per direction via `increasing.line.dash` + and `decreasing.line.dash`. + width + [object Object] Note that this style setting can also + be set per direction via `increasing.line.width` and + `decreasing.line.width`. + """ + + def __init__(self, arg=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.ohlc.Line` + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). Note that this style setting can + also be set per direction via `increasing.line.dash` + and `decreasing.line.dash`. + width + [object Object] Note that this style setting can also + be set per direction via `increasing.line.width` and + `decreasing.line.width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_stream.py new file mode 100644 index 0000000..5e753fb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "ohlc" + _path_str = "ohlc.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.ohlc.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/_line.py new file mode 100644 index 0000000..55ec4c4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/decreasing/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "ohlc.decreasing" + _path_str = "ohlc.decreasing.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.decreasing.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.decreasing.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.decreasing.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/_font.py new file mode 100644 index 0000000..de3f870 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "ohlc.hoverlabel" + _path_str = "ohlc.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/_line.py new file mode 100644 index 0000000..567f9cf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/increasing/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "ohlc.increasing" + _path_str = "ohlc.increasing.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.increasing.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.increasing.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.increasing.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/_font.py new file mode 100644 index 0000000..7d1cc80 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/ohlc/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "ohlc.legendgrouptitle" + _path_str = "ohlc.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.ohlc.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.ohlc.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.ohlc.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/__init__.py new file mode 100644 index 0000000..5289c29 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/__init__.py @@ -0,0 +1,29 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._dimension import Dimension + from ._domain import Domain + from ._labelfont import Labelfont + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._stream import Stream + from ._tickfont import Tickfont + from . import legendgrouptitle + from . import line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".legendgrouptitle", ".line"], + [ + "._dimension.Dimension", + "._domain.Domain", + "._labelfont.Labelfont", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._stream.Stream", + "._tickfont.Tickfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_dimension.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_dimension.py new file mode 100644 index 0000000..17a67da --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_dimension.py @@ -0,0 +1,383 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Dimension(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.dimension" + _valid_props = { + "categoryarray", + "categoryarraysrc", + "categoryorder", + "displayindex", + "label", + "ticktext", + "ticktextsrc", + "values", + "valuessrc", + "visible", + } + + @property + def categoryarray(self): + """ + Sets the order in which categories in this dimension appear. + Only has an effect if `categoryorder` is set to "array". Used + with `categoryorder`. + + The 'categoryarray' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["categoryarray"] + + @categoryarray.setter + def categoryarray(self, val): + self["categoryarray"] = val + + @property + def categoryarraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + + The 'categoryarraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["categoryarraysrc"] + + @categoryarraysrc.setter + def categoryarraysrc(self, val): + self["categoryarraysrc"] = val + + @property + def categoryorder(self): + """ + Specifies the ordering logic for the categories in the + dimension. By default, plotly uses "trace", which specifies the + order that is present in the data supplied. Set `categoryorder` + to *category ascending* or *category descending* if order + should be determined by the alphanumerical order of the + category names. Set `categoryorder` to "array" to derive the + ordering from the attribute `categoryarray`. If a category is + not found in the `categoryarray` array, the sorting behavior + for that attribute will be identical to the "trace" mode. The + unspecified categories will follow the categories in + `categoryarray`. + + The 'categoryorder' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['trace', 'category ascending', 'category descending', + 'array'] + + Returns + ------- + Any + """ + return self["categoryorder"] + + @categoryorder.setter + def categoryorder(self, val): + self["categoryorder"] = val + + @property + def displayindex(self): + """ + The display index of dimension, from left to right, zero + indexed, defaults to dimension index. + + The 'displayindex' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + + Returns + ------- + int + """ + return self["displayindex"] + + @displayindex.setter + def displayindex(self, val): + self["displayindex"] = val + + @property + def label(self): + """ + The shown name of the dimension. + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def ticktext(self): + """ + Sets alternative tick labels for the categories in this + dimension. Only has an effect if `categoryorder` is set to + "array". Should be an array the same length as `categoryarray` + Used with `categoryorder`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def values(self): + """ + Dimension values. `values[n]` represents the category value of + the `n`th point in the dataset, therefore the `values` vector + for all dimensions must be the same (longer vectors will be + truncated). + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + Shows the dimension when set to `true` (the default). Hides the + dimension for `false`. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + categoryarray + Sets the order in which categories in this dimension + appear. Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the categories in the + dimension. By default, plotly uses "trace", which + specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + displayindex + The display index of dimension, from left to right, + zero indexed, defaults to dimension index. + label + The shown name of the dimension. + ticktext + Sets alternative tick labels for the categories in this + dimension. Only has an effect if `categoryorder` is set + to "array". Should be an array the same length as + `categoryarray` Used with `categoryorder`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + values + Dimension values. `values[n]` represents the category + value of the `n`th point in the dataset, therefore the + `values` vector for all dimensions must be the same + (longer vectors will be truncated). + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + """ + + def __init__( + self, + arg=None, + categoryarray=None, + categoryarraysrc=None, + categoryorder=None, + displayindex=None, + label=None, + ticktext=None, + ticktextsrc=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Dimension object + + The dimensions (variables) of the parallel categories diagram. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.Dimension` + categoryarray + Sets the order in which categories in this dimension + appear. Only has an effect if `categoryorder` is set to + "array". Used with `categoryorder`. + categoryarraysrc + Sets the source reference on Chart Studio Cloud for + `categoryarray`. + categoryorder + Specifies the ordering logic for the categories in the + dimension. By default, plotly uses "trace", which + specifies the order that is present in the data + supplied. Set `categoryorder` to *category ascending* + or *category descending* if order should be determined + by the alphanumerical order of the category names. Set + `categoryorder` to "array" to derive the ordering from + the attribute `categoryarray`. If a category is not + found in the `categoryarray` array, the sorting + behavior for that attribute will be identical to the + "trace" mode. The unspecified categories will follow + the categories in `categoryarray`. + displayindex + The display index of dimension, from left to right, + zero indexed, defaults to dimension index. + label + The shown name of the dimension. + ticktext + Sets alternative tick labels for the categories in this + dimension. Only has an effect if `categoryorder` is set + to "array". Should be an array the same length as + `categoryarray` Used with `categoryorder`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + values + Dimension values. `values[n]` represents the category + value of the `n`th point in the dataset, therefore the + `values` vector for all dimensions must be the same + (longer vectors will be truncated). + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + + Returns + ------- + Dimension + """ + super().__init__("dimensions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Dimension +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Dimension`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("categoryarray", arg, categoryarray) + self._set_property("categoryarraysrc", arg, categoryarraysrc) + self._set_property("categoryorder", arg, categoryorder) + self._set_property("displayindex", arg, displayindex) + self._set_property("label", arg, label) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_domain.py new file mode 100644 index 0000000..6699f7b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this parcats trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this parcats trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this parcats trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this parcats trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this parcats trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcats trace . + x + Sets the horizontal domain of this parcats trace (in + plot fraction). + y + Sets the vertical domain of this parcats trace (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this parcats trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcats trace . + x + Sets the horizontal domain of this parcats trace (in + plot fraction). + y + Sets the vertical domain of this parcats trace (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_labelfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_labelfont.py new file mode 100644 index 0000000..8f3bd58 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_labelfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.labelfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Labelfont object + + Sets the font for the `dimension` labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.Labelfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Labelfont + """ + super().__init__("labelfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Labelfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Labelfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_legendgrouptitle.py new file mode 100644 index 0000000..180f8f8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.parcats.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_line.py new file mode 100644 index 0000000..72b01bc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_line.py @@ -0,0 +1,680 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "hovertemplate", + "reversescale", + "shape", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in `line.color` is set + to a numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `line.color`) or the bounds + set in `line.cmin` and `line.cmax` Has an effect only if in + `line.color` is set to a numerical array. Defaults to `false` + when `line.cmin` and `line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `line.color` is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmin` must + be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `line.cmin` + and/or `line.cmax` to be equidistant to this point. Has an + effect only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color`. Has no + effect when `line.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `line.color` is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmax` must + be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the line color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to `line.cmin` + and `line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to parcats.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.line.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.parcats.line.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `line.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be + a palette name string of the following list: Blackbody,Bluered, + Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portla + nd,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. This value + here applies when hovering over lines.Finally, the template + string has access to variables `count` and `probability`. + Anything contained in tag `` is displayed in the + secondary box, for example "{fullData.name}". To + hide the secondary box completely, use an empty tag + ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `line.color` is set to a numerical array. If true, `line.cmin` + will correspond to the last color in the array and `line.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def shape(self): + """ + Sets the shape of the paths. If `linear`, paths are composed of + straight lines. If `hspline`, paths are composed of horizontal + curved splines + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'hspline'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `line.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has an + effect only if in `line.color` is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color` is + set to a numerical array. Value should have the same + units as in `line.color`. Has no effect when + `line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets the line color. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.parcats.line.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `line.cmin` and `line.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. This value here applies when hovering + over lines.Finally, the template string has access to + variables `count` and `probability`. Anything contained + in tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color` is set to a numerical array. If + true, `line.cmin` will correspond to the last color in + the array and `line.cmax` will correspond to the first + color. + shape + Sets the shape of the paths. If `linear`, paths are + composed of straight lines. If `hspline`, paths are + composed of horizontal curved splines + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color` is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + hovertemplate=None, + reversescale=None, + shape=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcats.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has an + effect only if in `line.color` is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color` is + set to a numerical array. Value should have the same + units as in `line.color`. Has no effect when + `line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets the line color. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.parcats.line.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `line.cmin` and `line.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. This value here applies when hovering + over lines.Finally, the template string has access to + variables `count` and `probability`. Anything contained + in tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color` is set to a numerical array. If + true, `line.cmin` will correspond to the last color in + the array and `line.cmax` will correspond to the first + color. + shape + Sets the shape of the paths. If `linear`, paths are + composed of straight lines. If `hspline`, paths are + composed of horizontal curved splines + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color` is + set to a numerical array. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("reversescale", arg, reversescale) + self._set_property("shape", arg, shape) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_stream.py new file mode 100644 index 0000000..8d07078 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_tickfont.py new file mode 100644 index 0000000..630d6dc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "parcats" + _path_str = "parcats.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the font for the `category` labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/_font.py new file mode 100644 index 0000000..1f01359 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "parcats.legendgrouptitle" + _path_str = "parcats.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcats.legend + grouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/__init__.py new file mode 100644 index 0000000..5e06f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/_colorbar.py new file mode 100644 index 0000000..453686b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "parcats.line" + _path_str = "parcats.line.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.parcats.line.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.parcats.line.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.parcats.line.c + olorbar.tickformatstopdefaults), sets the default property + values to use for elements of + parcats.line.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.parcats.line.co + lorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcat + s.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcats.line.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.parcats.line.colorbar.Titl + e` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.line.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.parcats.line.co + lorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcat + s.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcats.line.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.parcats.line.colorbar.Titl + e` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.line.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.line.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickfont.py new file mode 100644 index 0000000..4f92e44 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "parcats.line.colorbar" + _path_str = "parcats.line.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcats.line.c + olorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py new file mode 100644 index 0000000..fc0ffbf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "parcats.line.colorbar" + _path_str = "parcats.line.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcats.line.c + olorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_title.py new file mode 100644 index 0000000..ec90649 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "parcats.line.colorbar" + _path_str = "parcats.line.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcats.line.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.parcats.line.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcats.line.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/_font.py new file mode 100644 index 0000000..37698b1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcats/line/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "parcats.line.colorbar.title" + _path_str = "parcats.line.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcats.line.c + olorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcats.line.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcats.line.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/__init__.py new file mode 100644 index 0000000..53ed764 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._dimension import Dimension + from ._domain import Domain + from ._labelfont import Labelfont + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._rangefont import Rangefont + from ._stream import Stream + from ._tickfont import Tickfont + from ._unselected import Unselected + from . import legendgrouptitle + from . import line + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".legendgrouptitle", ".line", ".unselected"], + [ + "._dimension.Dimension", + "._domain.Domain", + "._labelfont.Labelfont", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._rangefont.Rangefont", + "._stream.Stream", + "._tickfont.Tickfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_dimension.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_dimension.py new file mode 100644 index 0000000..0c28911 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_dimension.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Dimension(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.dimension" + _valid_props = { + "constraintrange", + "label", + "multiselect", + "name", + "range", + "templateitemname", + "tickformat", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "values", + "valuessrc", + "visible", + } + + @property + def constraintrange(self): + """ + The domain range to which the filter on the dimension is + constrained. Must be an array of `[fromValue, toValue]` with + `fromValue <= toValue`, or if `multiselect` is not disabled, + you may give an array of arrays, where each inner array is + `[fromValue, toValue]`. + + The 'constraintrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'constraintrange[0]' property accepts values of any type + (1) The 'constraintrange[1]' property accepts values of any type + + * a 2D list where: + (0) The 'constraintrange[i][0]' property accepts values of any type + (1) The 'constraintrange[i][1]' property accepts values of any type + + Returns + ------- + list + """ + return self["constraintrange"] + + @constraintrange.setter + def constraintrange(self, val): + self["constraintrange"] = val + + @property + def label(self): + """ + The shown name of the dimension. + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def multiselect(self): + """ + Do we allow multiple selection ranges or just a single range? + + The 'multiselect' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["multiselect"] + + @multiselect.setter + def multiselect(self, val): + self["multiselect"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def range(self): + """ + The domain range that represents the full, shown axis extent. + Defaults to the `values` extent. Must be an array of + `[fromValue, toValue]` with finite numbers as elements. + + The 'range' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'range[0]' property is a number and may be specified as: + - An int or float + (1) The 'range[1]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["range"] + + @range.setter + def range(self, val): + self["range"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def values(self): + """ + Dimension values. `values[n]` represents the value of the `n`th + point in the dataset, therefore the `values` vector for all + dimensions must be the same (longer vectors will be truncated). + Each value must be a finite number. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + Shows the dimension when set to `true` (the default). Hides the + dimension for `false`. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + constraintrange + The domain range to which the filter on the dimension + is constrained. Must be an array of `[fromValue, + toValue]` with `fromValue <= toValue`, or if + `multiselect` is not disabled, you may give an array of + arrays, where each inner array is `[fromValue, + toValue]`. + label + The shown name of the dimension. + multiselect + Do we allow multiple selection ranges or just a single + range? + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + range + The domain range that represents the full, shown axis + extent. Defaults to the `values` extent. Must be an + array of `[fromValue, toValue]` with finite numbers as + elements. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + ticktext + Sets the text displayed at the ticks position via + `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + values + Dimension values. `values[n]` represents the value of + the `n`th point in the dataset, therefore the `values` + vector for all dimensions must be the same (longer + vectors will be truncated). Each value must be a finite + number. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + """ + + def __init__( + self, + arg=None, + constraintrange=None, + label=None, + multiselect=None, + name=None, + range=None, + templateitemname=None, + tickformat=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Dimension object + + The dimensions (variables) of the parallel coordinates chart. + 2..60 dimensions are supported. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Dimension` + constraintrange + The domain range to which the filter on the dimension + is constrained. Must be an array of `[fromValue, + toValue]` with `fromValue <= toValue`, or if + `multiselect` is not disabled, you may give an array of + arrays, where each inner array is `[fromValue, + toValue]`. + label + The shown name of the dimension. + multiselect + Do we allow multiple selection ranges or just a single + range? + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + range + The domain range that represents the full, shown axis + extent. Defaults to the `values` extent. Must be an + array of `[fromValue, toValue]` with finite numbers as + elements. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + ticktext + Sets the text displayed at the ticks position via + `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + values + Dimension values. `values[n]` represents the value of + the `n`th point in the dataset, therefore the `values` + vector for all dimensions must be the same (longer + vectors will be truncated). Each value must be a finite + number. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + visible + Shows the dimension when set to `true` (the default). + Hides the dimension for `false`. + + Returns + ------- + Dimension + """ + super().__init__("dimensions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Dimension +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Dimension`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("constraintrange", arg, constraintrange) + self._set_property("label", arg, label) + self._set_property("multiselect", arg, multiselect) + self._set_property("name", arg, name) + self._set_property("range", arg, range) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("tickformat", arg, tickformat) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_domain.py new file mode 100644 index 0000000..a1b3f57 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this parcoords trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this parcoords trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this parcoords trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this parcoords trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this parcoords trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcoords trace . + x + Sets the horizontal domain of this parcoords trace (in + plot fraction). + y + Sets the vertical domain of this parcoords trace (in + plot fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this parcoords trace . + row + If there is a layout grid, use the domain for this row + in the grid for this parcoords trace . + x + Sets the horizontal domain of this parcoords trace (in + plot fraction). + y + Sets the vertical domain of this parcoords trace (in + plot fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_labelfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_labelfont.py new file mode 100644 index 0000000..b73fe48 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_labelfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Labelfont(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.labelfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Labelfont object + + Sets the font for the `dimension` labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Labelfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Labelfont + """ + super().__init__("labelfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Labelfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Labelfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_legendgrouptitle.py new file mode 100644 index 0000000..67462f3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.parcoords.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_line.py new file mode 100644 index 0000000..82478ae --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_line.py @@ -0,0 +1,540 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in `line.color` is set + to a numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `line.color`) or the bounds + set in `line.cmin` and `line.cmax` Has an effect only if in + `line.color` is set to a numerical array. Defaults to `false` + when `line.cmin` and `line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `line.color` is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmin` must + be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `line.cmin` + and/or `line.cmax` to be equidistant to this point. Has an + effect only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color`. Has no + effect when `line.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `line.color` is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmax` must + be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the line color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to `line.cmin` + and `line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to parcoords.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.line.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.parcoords.line.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `line.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be + a palette name string of the following list: Blackbody,Bluered, + Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portla + nd,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `line.color` is set to a numerical array. If true, `line.cmin` + will correspond to the last color in the array and `line.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `line.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has an + effect only if in `line.color` is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color` is + set to a numerical array. Value should have the same + units as in `line.color`. Has no effect when + `line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets the line color. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.parcoords.line.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `line.cmin` and `line.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color` is set to a numerical array. If + true, `line.cmin` will correspond to the last color in + the array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color` is + set to a numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has an + effect only if in `line.color` is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color` is + set to a numerical array. Value should have the same + units as in `line.color`. Has no effect when + `line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets the line color. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.parcoords.line.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `line.cmin` and `line.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color` is set to a numerical array. If + true, `line.cmin` will correspond to the last color in + the array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color` is + set to a numerical array. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_rangefont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_rangefont.py new file mode 100644 index 0000000..1e19cef --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_rangefont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Rangefont(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.rangefont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Rangefont object + + Sets the font for the `dimension` range values. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Rangefont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Rangefont + """ + super().__init__("rangefont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Rangefont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Rangefont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_stream.py new file mode 100644 index 0000000..a3753b1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_tickfont.py new file mode 100644 index 0000000..676f0ad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the font for the `dimension` tick values. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_unselected.py new file mode 100644 index 0000000..576feb6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "parcoords" + _path_str = "parcoords.unselected" + _valid_props = {"line"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.unselected.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.parcoords.unselected.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.parcoords.unselected.Line` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, line=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.Unselected` + line + :class:`plotly.graph_objects.parcoords.unselected.Line` + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/_font.py new file mode 100644 index 0000000..32fda37 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.legendgrouptitle" + _path_str = "parcoords.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcoords.lege + ndgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/__init__.py new file mode 100644 index 0000000..5e06f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/_colorbar.py new file mode 100644 index 0000000..43cf23b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.line" + _path_str = "parcoords.line.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.parcoords.line.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.parcoords.line.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.parcoords.line + .colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + parcoords.line.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.parcoords.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcoo + rds.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcoords.line.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.parcoords.line.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.line.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.parcoords.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.parcoo + rds.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + parcoords.line.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.parcoords.line.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.line.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.line.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py new file mode 100644 index 0000000..8737a56 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.line.colorbar" + _path_str = "parcoords.line.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py new file mode 100644 index 0000000..0cbc645 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.line.colorbar" + _path_str = "parcoords.line.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_title.py new file mode 100644 index 0000000..caa26b0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.line.colorbar" + _path_str = "parcoords.line.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.parcoords.line.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.parcoords.line.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/_font.py new file mode 100644 index 0000000..d09e6f7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/line/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.line.colorbar.title" + _path_str = "parcoords.line.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.parcoords.line + .colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.line.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.line.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/_line.py new file mode 100644 index 0000000..0f34094 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/parcoords/unselected/_line.py @@ -0,0 +1,115 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "parcoords.unselected" + _path_str = "parcoords.unselected.line" + _valid_props = {"color", "opacity"} + + @property + def color(self): + """ + Sets the base color of unselected lines. in connection with + `unselected.line.opacity`. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the opacity of unselected lines. The default "auto" + decreases the opacity smoothly as the number of lines + increases. Use 1 to achieve exact `unselected.line.color`. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the base color of unselected lines. in connection + with `unselected.line.opacity`. + opacity + Sets the opacity of unselected lines. The default + "auto" decreases the opacity smoothly as the number of + lines increases. Use 1 to achieve exact + `unselected.line.color`. + """ + + def __init__(self, arg=None, color=None, opacity=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.parcoords.unselected.Line` + color + Sets the base color of unselected lines. in connection + with `unselected.line.opacity`. + opacity + Sets the opacity of unselected lines. The default + "auto" decreases the opacity smoothly as the number of + lines increases. Use 1 to achieve exact + `unselected.line.color`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.parcoords.unselected.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.parcoords.unselected.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/__init__.py new file mode 100644 index 0000000..4444182 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/__init__.py @@ -0,0 +1,35 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._stream import Stream + from ._textfont import Textfont + from ._title import Title + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".title"], + [ + "._domain.Domain", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._stream.Stream", + "._textfont.Textfont", + "._title.Title", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_domain.py new file mode 100644 index 0000000..fd3dee6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_domain.py @@ -0,0 +1,168 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this pie trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this pie trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this pie trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this pie trace (in plot fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this pie trace . + row + If there is a layout grid, use the domain for this row + in the grid for this pie trace . + x + Sets the horizontal domain of this pie trace (in plot + fraction). + y + Sets the vertical domain of this pie trace (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.pie.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this pie trace . + row + If there is a layout grid, use the domain for this row + in the grid for this pie trace . + x + Sets the horizontal domain of this pie trace (in plot + fraction). + y + Sets the vertical domain of this pie trace (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_hoverlabel.py new file mode 100644 index 0000000..674f659 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.pie.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_insidetextfont.py new file mode 100644 index 0000000..cf59dbe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `textinfo` lying inside the sector. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_legendgrouptitle.py new file mode 100644 index 0000000..ff1230c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.pie.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_marker.py new file mode 100644 index 0000000..49f0443 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_marker.py @@ -0,0 +1,160 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.marker" + _valid_props = {"colors", "colorssrc", "line", "pattern"} + + @property + def colors(self): + """ + Sets the color of each sector. If not specified, the default + trace color set is used to pick the sector colors. + + The 'colors' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["colors"] + + @colors.setter + def colors(self, val): + self["colors"] = val + + @property + def colorssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `colors`. + + The 'colorssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorssrc"] + + @colorssrc.setter + def colorssrc(self, val): + self["colorssrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.pie.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.pie.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def _prop_descriptions(self): + return """\ + colors + Sets the color of each sector. If not specified, the + default trace color set is used to pick the sector + colors. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.pie.marker.Line` instance + or dict with compatible properties + pattern + Sets the pattern within the marker. + """ + + def __init__( + self, arg=None, colors=None, colorssrc=None, line=None, pattern=None, **kwargs + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.pie.Marker` + colors + Sets the color of each sector. If not specified, the + default trace color set is used to pick the sector + colors. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.pie.marker.Line` instance + or dict with compatible properties + pattern + Sets the pattern within the marker. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("colors", arg, colors) + self._set_property("colorssrc", arg, colorssrc) + self._set_property("line", arg, line) + self._set_property("pattern", arg, pattern) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_outsidetextfont.py new file mode 100644 index 0000000..dac483e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_outsidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `textinfo` lying outside the sector. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_stream.py new file mode 100644 index 0000000..d8187aa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.pie.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_textfont.py new file mode 100644 index 0000000..3ad5c97 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_textfont.py @@ -0,0 +1,586 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `textinfo`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.pie.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_title.py new file mode 100644 index 0000000..84582a5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/_title.py @@ -0,0 +1,131 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "pie" + _path_str = "pie.title" + _valid_props = {"font", "position", "text"} + + @property + def font(self): + """ + Sets the font used for `title`. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.pie.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.pie.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def position(self): + """ + Specifies the location of the `title`. + + The 'position' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top left', 'top center', 'top right', 'middle center', + 'bottom left', 'bottom center', 'bottom right'] + + Returns + ------- + Any + """ + return self["position"] + + @position.setter + def position(self, val): + self["position"] = val + + @property + def text(self): + """ + Sets the title of the chart. If it is empty, no title is + displayed. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets the font used for `title`. + position + Specifies the location of the `title`. + text + Sets the title of the chart. If it is empty, no title + is displayed. + """ + + def __init__(self, arg=None, font=None, position=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.pie.Title` + font + Sets the font used for `title`. + position + Specifies the location of the `title`. + text + Sets the title of the chart. If it is empty, no title + is displayed. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("position", arg, position) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/_font.py new file mode 100644 index 0000000..556bfc2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "pie.hoverlabel" + _path_str = "pie.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/_font.py new file mode 100644 index 0000000..fff0d0d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "pie.legendgrouptitle" + _path_str = "pie.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/__init__.py new file mode 100644 index 0000000..ae09590 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line + from ._pattern import Pattern +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._line.Line", "._pattern.Pattern"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_line.py new file mode 100644 index 0000000..3fdf9ce --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_line.py @@ -0,0 +1,160 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "pie.marker" + _path_str = "pie.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.marker.Line` + color + Sets the color of the line enclosing each sector. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_pattern.py new file mode 100644 index 0000000..db8b13e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "pie.marker" + _path_str = "pie.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/_font.py new file mode 100644 index 0000000..abe9386 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/pie/title/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "pie.title" + _path_str = "pie.title.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used for `title`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.pie.title.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.pie.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.pie.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/__init__.py new file mode 100644 index 0000000..257626f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/__init__.py @@ -0,0 +1,31 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._link import Link + from ._node import Node + from ._stream import Stream + from ._textfont import Textfont + from . import hoverlabel + from . import legendgrouptitle + from . import link + from . import node +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".link", ".node"], + [ + "._domain.Domain", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._link.Link", + "._node.Node", + "._stream.Stream", + "._textfont.Textfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_domain.py new file mode 100644 index 0000000..c86377e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_domain.py @@ -0,0 +1,169 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this sankey trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this sankey trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this sankey trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this sankey trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this sankey trace . + row + If there is a layout grid, use the domain for this row + in the grid for this sankey trace . + x + Sets the horizontal domain of this sankey trace (in + plot fraction). + y + Sets the vertical domain of this sankey trace (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sankey.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this sankey trace . + row + If there is a layout grid, use the domain for this row + in the grid for this sankey trace . + x + Sets the horizontal domain of this sankey trace (in + plot fraction). + y + Sets the vertical domain of this sankey trace (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_hoverlabel.py new file mode 100644 index 0000000..32d95a9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sankey.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_legendgrouptitle.py new file mode 100644 index 0000000..8f02463 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sankey.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_link.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_link.py new file mode 100644 index 0000000..d436fd8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_link.py @@ -0,0 +1,784 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Link(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.link" + _valid_props = { + "arrowlen", + "color", + "colorscaledefaults", + "colorscales", + "colorsrc", + "customdata", + "customdatasrc", + "hovercolor", + "hovercolorsrc", + "hoverinfo", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "label", + "labelsrc", + "line", + "source", + "sourcesrc", + "target", + "targetsrc", + "value", + "valuesrc", + } + + @property + def arrowlen(self): + """ + Sets the length (in px) of the links arrow, if 0 no arrow will + be drawn. + + The 'arrowlen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["arrowlen"] + + @arrowlen.setter + def arrowlen(self, val): + self["arrowlen"] = val + + @property + def color(self): + """ + Sets the `link` color. It can be a single value, or an array + for specifying color for each `link`. If `link.color` is + omitted, then by default, a translucent grey link will be used. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorscales(self): + """ + The 'colorscales' property is a tuple of instances of + Colorscale that may be specified as: + - A list or tuple of instances of plotly.graph_objs.sankey.link.Colorscale + - A list or tuple of dicts of string/value properties that + will be passed to the Colorscale constructor + + Returns + ------- + tuple[plotly.graph_objs.sankey.link.Colorscale] + """ + return self["colorscales"] + + @colorscales.setter + def colorscales(self, val): + self["colorscales"] = val + + @property + def colorscaledefaults(self): + """ + When used in a template (as + layout.template.data.sankey.link.colorscaledefaults), sets the + default property values to use for elements of + sankey.link.colorscales + + The 'colorscaledefaults' property is an instance of Colorscale + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.link.Colorscale` + - A dict of string/value properties that will be passed + to the Colorscale constructor + + Returns + ------- + plotly.graph_objs.sankey.link.Colorscale + """ + return self["colorscaledefaults"] + + @colorscaledefaults.setter + def colorscaledefaults(self, val): + self["colorscaledefaults"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def customdata(self): + """ + Assigns extra data to each link. + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def hovercolor(self): + """ + Sets the `link` hover color. It can be a single value, or an + array for specifying hover colors for each `link`. If + `link.hovercolor` is omitted, then by default, links will + become slightly more opaque when hovered over. + + The 'hovercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovercolor"] + + @hovercolor.setter + def hovercolor(self, val): + self["hovercolor"] = val + + @property + def hovercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovercolor`. + + The 'hovercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovercolorsrc"] + + @hovercolorsrc.setter + def hovercolorsrc(self, val): + self["hovercolorsrc"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear when hovering links. + If `none` or `skip` are set, no information is displayed upon + hovering. But, if `none` is set, click and hover events are + still fired. + + The 'hoverinfo' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'none', 'skip'] + + Returns + ------- + Any + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.link.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.sankey.link.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Variables + `source` and `target` are node objects.Finally, the template + string has access to variables `value` and `label`. Anything + contained in tag `` is displayed in the secondary box, + for example "{fullData.name}". To hide the + secondary box completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def label(self): + """ + The shown name of the link. + + The 'label' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def labelsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `label`. + + The 'labelsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelsrc"] + + @labelsrc.setter + def labelsrc(self, val): + self["labelsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.link.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.sankey.link.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def source(self): + """ + An integer number `[0..nodes.length - 1]` that represents the + source node. + + The 'source' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["source"] + + @source.setter + def source(self, val): + self["source"] = val + + @property + def sourcesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `source`. + + The 'sourcesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sourcesrc"] + + @sourcesrc.setter + def sourcesrc(self, val): + self["sourcesrc"] = val + + @property + def target(self): + """ + An integer number `[0..nodes.length - 1]` that represents the + target node. + + The 'target' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["target"] + + @target.setter + def target(self, val): + self["target"] = val + + @property + def targetsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `target`. + + The 'targetsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["targetsrc"] + + @targetsrc.setter + def targetsrc(self, val): + self["targetsrc"] = val + + @property + def value(self): + """ + A numeric value representing the flow volume value. + + The 'value' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valuesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `value`. + + The 'valuesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuesrc"] + + @valuesrc.setter + def valuesrc(self, val): + self["valuesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + arrowlen + Sets the length (in px) of the links arrow, if 0 no + arrow will be drawn. + color + Sets the `link` color. It can be a single value, or an + array for specifying color for each `link`. If + `link.color` is omitted, then by default, a translucent + grey link will be used. + colorscales + A tuple of + :class:`plotly.graph_objects.sankey.link.Colorscale` + instances or dicts with compatible properties + colorscaledefaults + When used in a template (as + layout.template.data.sankey.link.colorscaledefaults), + sets the default property values to use for elements of + sankey.link.colorscales + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + customdata + Assigns extra data to each link. + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hovercolor + Sets the `link` hover color. It can be a single value, + or an array for specifying hover colors for each + `link`. If `link.hovercolor` is omitted, then by + default, links will become slightly more opaque when + hovered over. + hovercolorsrc + Sets the source reference on Chart Studio Cloud for + `hovercolor`. + hoverinfo + Determines which trace information appear when hovering + links. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + :class:`plotly.graph_objects.sankey.link.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Variables `source` and `target` are + node objects.Finally, the template string has access to + variables `value` and `label`. Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + label + The shown name of the link. + labelsrc + Sets the source reference on Chart Studio Cloud for + `label`. + line + :class:`plotly.graph_objects.sankey.link.Line` instance + or dict with compatible properties + source + An integer number `[0..nodes.length - 1]` that + represents the source node. + sourcesrc + Sets the source reference on Chart Studio Cloud for + `source`. + target + An integer number `[0..nodes.length - 1]` that + represents the target node. + targetsrc + Sets the source reference on Chart Studio Cloud for + `target`. + value + A numeric value representing the flow volume value. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + """ + + def __init__( + self, + arg=None, + arrowlen=None, + color=None, + colorscales=None, + colorscaledefaults=None, + colorsrc=None, + customdata=None, + customdatasrc=None, + hovercolor=None, + hovercolorsrc=None, + hoverinfo=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + label=None, + labelsrc=None, + line=None, + source=None, + sourcesrc=None, + target=None, + targetsrc=None, + value=None, + valuesrc=None, + **kwargs, + ): + """ + Construct a new Link object + + The links of the Sankey plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sankey.Link` + arrowlen + Sets the length (in px) of the links arrow, if 0 no + arrow will be drawn. + color + Sets the `link` color. It can be a single value, or an + array for specifying color for each `link`. If + `link.color` is omitted, then by default, a translucent + grey link will be used. + colorscales + A tuple of + :class:`plotly.graph_objects.sankey.link.Colorscale` + instances or dicts with compatible properties + colorscaledefaults + When used in a template (as + layout.template.data.sankey.link.colorscaledefaults), + sets the default property values to use for elements of + sankey.link.colorscales + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + customdata + Assigns extra data to each link. + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + hovercolor + Sets the `link` hover color. It can be a single value, + or an array for specifying hover colors for each + `link`. If `link.hovercolor` is omitted, then by + default, links will become slightly more opaque when + hovered over. + hovercolorsrc + Sets the source reference on Chart Studio Cloud for + `hovercolor`. + hoverinfo + Determines which trace information appear when hovering + links. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + :class:`plotly.graph_objects.sankey.link.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Variables `source` and `target` are + node objects.Finally, the template string has access to + variables `value` and `label`. Anything contained in + tag `` is displayed in the secondary box, for + example "{fullData.name}". To hide the + secondary box completely, use an empty tag + ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + label + The shown name of the link. + labelsrc + Sets the source reference on Chart Studio Cloud for + `label`. + line + :class:`plotly.graph_objects.sankey.link.Line` instance + or dict with compatible properties + source + An integer number `[0..nodes.length - 1]` that + represents the source node. + sourcesrc + Sets the source reference on Chart Studio Cloud for + `source`. + target + An integer number `[0..nodes.length - 1]` that + represents the target node. + targetsrc + Sets the source reference on Chart Studio Cloud for + `target`. + value + A numeric value representing the flow volume value. + valuesrc + Sets the source reference on Chart Studio Cloud for + `value`. + + Returns + ------- + Link + """ + super().__init__("link") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Link +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Link`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("arrowlen", arg, arrowlen) + self._set_property("color", arg, color) + self._set_property("colorscales", arg, colorscales) + self._set_property("colorscaledefaults", arg, colorscaledefaults) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("hovercolor", arg, hovercolor) + self._set_property("hovercolorsrc", arg, hovercolorsrc) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("label", arg, label) + self._set_property("labelsrc", arg, labelsrc) + self._set_property("line", arg, line) + self._set_property("source", arg, source) + self._set_property("sourcesrc", arg, sourcesrc) + self._set_property("target", arg, target) + self._set_property("targetsrc", arg, targetsrc) + self._set_property("value", arg, value) + self._set_property("valuesrc", arg, valuesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_node.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_node.py new file mode 100644 index 0000000..1e05e7a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_node.py @@ -0,0 +1,682 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Node(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.node" + _valid_props = { + "align", + "color", + "colorsrc", + "customdata", + "customdatasrc", + "groups", + "hoverinfo", + "hoverlabel", + "hovertemplate", + "hovertemplatesrc", + "label", + "labelsrc", + "line", + "pad", + "thickness", + "x", + "xsrc", + "y", + "ysrc", + } + + @property + def align(self): + """ + Sets the alignment method used to position the nodes along the + horizontal axis. + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['justify', 'left', 'right', 'center'] + + Returns + ------- + Any + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def color(self): + """ + Sets the `node` color. It can be a single value, or an array + for specifying color for each `node`. If `node.color` is + omitted, then the default `Plotly` color palette will be cycled + through to have a variety of colors. These defaults are not + fully opaque, to allow some visibility of what is beneath the + node. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def customdata(self): + """ + Assigns extra data to each node. + + The 'customdata' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["customdata"] + + @customdata.setter + def customdata(self, val): + self["customdata"] = val + + @property + def customdatasrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `customdata`. + + The 'customdatasrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["customdatasrc"] + + @customdatasrc.setter + def customdatasrc(self, val): + self["customdatasrc"] = val + + @property + def groups(self): + """ + Groups of nodes. Each group is defined by an array with the + indices of the nodes it contains. Multiple groups can be + specified. + + The 'groups' property is an info array that may be specified as: + * a 2D list where: + The 'groups[i][j]' property is a number and may be specified as: + - An int or float + + Returns + ------- + list + """ + return self["groups"] + + @groups.setter + def groups(self, val): + self["groups"] = val + + @property + def hoverinfo(self): + """ + Determines which trace information appear when hovering nodes. + If `none` or `skip` are set, no information is displayed upon + hovering. But, if `none` is set, click and hover events are + still fired. + + The 'hoverinfo' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'none', 'skip'] + + Returns + ------- + Any + """ + return self["hoverinfo"] + + @hoverinfo.setter + def hoverinfo(self, val): + self["hoverinfo"] = val + + @property + def hoverlabel(self): + """ + The 'hoverlabel' property is an instance of Hoverlabel + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.node.Hoverlabel` + - A dict of string/value properties that will be passed + to the Hoverlabel constructor + + Returns + ------- + plotly.graph_objs.sankey.node.Hoverlabel + """ + return self["hoverlabel"] + + @hoverlabel.setter + def hoverlabel(self, val): + self["hoverlabel"] = val + + @property + def hovertemplate(self): + """ + Template string used for rendering the information that appear + on hover box. Note that this will override `hoverinfo`. + Variables are inserted using %{variable}, for example "y: %{y}" + as well as %{xother}, {%_xother}, {%_xother_}, {%xother_}. When + showing info for several points, "xother" will be added to + those with different x positions from the first point. An + underscore before or after "(x|y)other" will add a space on + that side, only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for example + "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the date + formatting syntax. The variables available in `hovertemplate` + are the ones emitted as event data described at this link + https://plotly.com/javascript/plotlyjs-events/#event-data. + Additionally, every attributes that can be specified per-point + (the ones that are `arrayOk: true`) are available. Variables + `sourceLinks` and `targetLinks` are arrays of link + objects.Finally, the template string has access to variables + `value` and `label`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary box + completely, use an empty tag ``. + + The 'hovertemplate' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["hovertemplate"] + + @hovertemplate.setter + def hovertemplate(self, val): + self["hovertemplate"] = val + + @property + def hovertemplatesrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + + The 'hovertemplatesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["hovertemplatesrc"] + + @hovertemplatesrc.setter + def hovertemplatesrc(self, val): + self["hovertemplatesrc"] = val + + @property + def label(self): + """ + The shown name of the node. + + The 'label' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def labelsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `label`. + + The 'labelsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["labelsrc"] + + @labelsrc.setter + def labelsrc(self, val): + self["labelsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.node.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.sankey.node.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def pad(self): + """ + Sets the padding (in px) between the `nodes`. + + The 'pad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the `nodes`. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def x(self): + """ + The normalized horizontal position of the node. + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + The normalized vertical position of the node. + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the alignment method used to position the nodes + along the horizontal axis. + color + Sets the `node` color. It can be a single value, or an + array for specifying color for each `node`. If + `node.color` is omitted, then the default `Plotly` + color palette will be cycled through to have a variety + of colors. These defaults are not fully opaque, to + allow some visibility of what is beneath the node. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + customdata + Assigns extra data to each node. + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + groups + Groups of nodes. Each group is defined by an array with + the indices of the nodes it contains. Multiple groups + can be specified. + hoverinfo + Determines which trace information appear when hovering + nodes. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + :class:`plotly.graph_objects.sankey.node.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Variables `sourceLinks` and + `targetLinks` are arrays of link objects.Finally, the + template string has access to variables `value` and + `label`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + label + The shown name of the node. + labelsrc + Sets the source reference on Chart Studio Cloud for + `label`. + line + :class:`plotly.graph_objects.sankey.node.Line` instance + or dict with compatible properties + pad + Sets the padding (in px) between the `nodes`. + thickness + Sets the thickness (in px) of the `nodes`. + x + The normalized horizontal position of the node. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + The normalized vertical position of the node. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + """ + + def __init__( + self, + arg=None, + align=None, + color=None, + colorsrc=None, + customdata=None, + customdatasrc=None, + groups=None, + hoverinfo=None, + hoverlabel=None, + hovertemplate=None, + hovertemplatesrc=None, + label=None, + labelsrc=None, + line=None, + pad=None, + thickness=None, + x=None, + xsrc=None, + y=None, + ysrc=None, + **kwargs, + ): + """ + Construct a new Node object + + The nodes of the Sankey plot. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sankey.Node` + align + Sets the alignment method used to position the nodes + along the horizontal axis. + color + Sets the `node` color. It can be a single value, or an + array for specifying color for each `node`. If + `node.color` is omitted, then the default `Plotly` + color palette will be cycled through to have a variety + of colors. These defaults are not fully opaque, to + allow some visibility of what is beneath the node. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + customdata + Assigns extra data to each node. + customdatasrc + Sets the source reference on Chart Studio Cloud for + `customdata`. + groups + Groups of nodes. Each group is defined by an array with + the indices of the nodes it contains. Multiple groups + can be specified. + hoverinfo + Determines which trace information appear when hovering + nodes. If `none` or `skip` are set, no information is + displayed upon hovering. But, if `none` is set, click + and hover events are still fired. + hoverlabel + :class:`plotly.graph_objects.sankey.node.Hoverlabel` + instance or dict with compatible properties + hovertemplate + Template string used for rendering the information that + appear on hover box. Note that this will override + `hoverinfo`. Variables are inserted using %{variable}, + for example "y: %{y}" as well as %{xother}, {%_xother}, + {%_xother_}, {%xother_}. When showing info for several + points, "xother" will be added to those with different + x positions from the first point. An underscore before + or after "(x|y)other" will add a space on that side, + only when this field is shown. Numbers are formatted + using d3-format's syntax %{variable:d3-format}, for + example "Price: %{y:$.2f}". + https://github.com/d3/d3-format/tree/v1.4.5#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-time- + format/tree/v2.2.3#locale_format for details on the + date formatting syntax. The variables available in + `hovertemplate` are the ones emitted as event data + described at this link + https://plotly.com/javascript/plotlyjs-events/#event- + data. Additionally, every attributes that can be + specified per-point (the ones that are `arrayOk: true`) + are available. Variables `sourceLinks` and + `targetLinks` are arrays of link objects.Finally, the + template string has access to variables `value` and + `label`. Anything contained in tag `` is + displayed in the secondary box, for example + "{fullData.name}". To hide the secondary + box completely, use an empty tag ``. + hovertemplatesrc + Sets the source reference on Chart Studio Cloud for + `hovertemplate`. + label + The shown name of the node. + labelsrc + Sets the source reference on Chart Studio Cloud for + `label`. + line + :class:`plotly.graph_objects.sankey.node.Line` instance + or dict with compatible properties + pad + Sets the padding (in px) between the `nodes`. + thickness + Sets the thickness (in px) of the `nodes`. + x + The normalized horizontal position of the node. + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + The normalized vertical position of the node. + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + + Returns + ------- + Node + """ + super().__init__("node") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Node +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Node`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("customdata", arg, customdata) + self._set_property("customdatasrc", arg, customdatasrc) + self._set_property("groups", arg, groups) + self._set_property("hoverinfo", arg, hoverinfo) + self._set_property("hoverlabel", arg, hoverlabel) + self._set_property("hovertemplate", arg, hovertemplate) + self._set_property("hovertemplatesrc", arg, hovertemplatesrc) + self._set_property("label", arg, label) + self._set_property("labelsrc", arg, labelsrc) + self._set_property("line", arg, line) + self._set_property("pad", arg, pad) + self._set_property("thickness", arg, thickness) + self._set_property("x", arg, x) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("ysrc", arg, ysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_stream.py new file mode 100644 index 0000000..542d7c1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sankey.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_textfont.py new file mode 100644 index 0000000..d052501 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/_textfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "sankey" + _path_str = "sankey.textfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font for node labels + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/_font.py new file mode 100644 index 0000000..3d9d60f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sankey.hoverlabel" + _path_str = "sankey.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/_font.py new file mode 100644 index 0000000..2887958 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sankey.legendgrouptitle" + _path_str = "sankey.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/__init__.py new file mode 100644 index 0000000..7170211 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorscale import Colorscale + from ._hoverlabel import Hoverlabel + from ._line import Line + from . import hoverlabel +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel"], + ["._colorscale.Colorscale", "._hoverlabel.Hoverlabel", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_colorscale.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_colorscale.py new file mode 100644 index 0000000..61d0934 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_colorscale.py @@ -0,0 +1,304 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Colorscale(_BaseTraceHierarchyType): + _parent_path_str = "sankey.link" + _path_str = "sankey.link.colorscale" + _valid_props = {"cmax", "cmin", "colorscale", "label", "name", "templateitemname"} + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def colorscale(self): + """ + 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def label(self): + """ + The label of the links to color based on their concentration + within a flow. + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def _prop_descriptions(self): + return """\ + cmax + Sets the upper bound of the color domain. + cmin + Sets the lower bound of the color domain. + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + label + The label of the links to color based on their + concentration within a flow. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + """ + + def __init__( + self, + arg=None, + cmax=None, + cmin=None, + colorscale=None, + label=None, + name=None, + templateitemname=None, + **kwargs, + ): + """ + Construct a new Colorscale object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.link.Colorscale` + cmax + Sets the upper bound of the color domain. + cmin + Sets the lower bound of the color domain. + 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the + colorscale in color space, use `cmin` and `cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + label + The label of the links to color based on their + concentration within a flow. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + + Returns + ------- + Colorscale + """ + super().__init__("colorscales") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.link.Colorscale +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.link.Colorscale`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("cmax", arg, cmax) + self._set_property("cmin", arg, cmin) + self._set_property("colorscale", arg, colorscale) + self._set_property("label", arg, label) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_hoverlabel.py new file mode 100644 index 0000000..e5684a2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "sankey.link" + _path_str = "sankey.link.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sankey.link.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.link.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.link.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.link.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_line.py new file mode 100644 index 0000000..feb0d9e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/_line.py @@ -0,0 +1,160 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "sankey.link" + _path_str = "sankey.link.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the `line` around each `link`. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the `line` around each `link`. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the `line` around each `link`. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the `line` around each + `link`. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.link.Line` + color + Sets the color of the `line` around each `link`. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the `line` around each + `link`. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.link.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.link.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/_font.py new file mode 100644 index 0000000..e96c178 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/link/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sankey.link.hoverlabel" + _path_str = "sankey.link.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.link.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.link.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.link.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/__init__.py new file mode 100644 index 0000000..dfd0787 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._line import Line + from . import hoverlabel +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".hoverlabel"], ["._hoverlabel.Hoverlabel", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_hoverlabel.py new file mode 100644 index 0000000..22a6590 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "sankey.node" + _path_str = "sankey.node.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sankey.node.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sankey.node.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.node.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.node.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.node.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_line.py new file mode 100644 index 0000000..d3855f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/_line.py @@ -0,0 +1,160 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "sankey.node" + _path_str = "sankey.node.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the `line` around each `node`. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the `line` around each `node`. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the `line` around each `node`. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the `line` around each + `node`. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.node.Line` + color + Sets the color of the `line` around each `node`. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the `line` around each + `node`. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.node.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.node.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/_font.py new file mode 100644 index 0000000..545db57 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sankey/node/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sankey.node.hoverlabel" + _path_str = "sankey.node.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sankey.node.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sankey.node.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sankey.node.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/__init__.py new file mode 100644 index 0000000..c4452eb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/__init__.py @@ -0,0 +1,42 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._error_x import ErrorX + from ._error_y import ErrorY + from ._fillgradient import Fillgradient + from ._fillpattern import Fillpattern + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._error_x.ErrorX", + "._error_y.ErrorY", + "._fillgradient.Fillgradient", + "._fillpattern.Fillpattern", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_x.py new file mode 100644 index 0000000..b312a56 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_x.py @@ -0,0 +1,503 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.error_x" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "copy_ystyle", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["copy_ystyle"] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self["copy_ystyle"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.ErrorX` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super().__init__("error_x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.ErrorX +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.ErrorX`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("copy_ystyle", arg, copy_ystyle) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_y.py new file mode 100644 index 0000000..a5a8228 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_error_y.py @@ -0,0 +1,480 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.error_y" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.ErrorY` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super().__init__("error_y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.ErrorY +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.ErrorY`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillgradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillgradient.py new file mode 100644 index 0000000..1df626d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillgradient.py @@ -0,0 +1,227 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Fillgradient(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.fillgradient" + _valid_props = {"colorscale", "start", "stop", "type"} + + @property + def colorscale(self): + """ + Sets the fill gradient colors as a color scale. The color scale + is interpreted as a gradient applied in the direction specified + by "orientation", from the lowest to the highest value of the + scatter plot along that axis, or from the center to the most + distant point from it, if orientation is "radial". + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def start(self): + """ + Sets the gradient start value. It is given as the absolute + position on the axis determined by the orientiation. E.g., if + orientation is "horizontal", the gradient will be horizontal + and start from the x-position given by start. If omitted, the + gradient starts at the lowest value of the trace along the + respective axis. Ignored if orientation is "radial". + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def stop(self): + """ + Sets the gradient end value. It is given as the absolute + position on the axis determined by the orientiation. E.g., if + orientation is "horizontal", the gradient will be horizontal + and end at the x-position given by end. If omitted, the + gradient ends at the highest value of the trace along the + respective axis. Ignored if orientation is "radial". + + The 'stop' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["stop"] + + @stop.setter + def stop(self, val): + self["stop"] = val + + @property + def type(self): + """ + Sets the type/orientation of the color gradient for the fill. + Defaults to "none". + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def _prop_descriptions(self): + return """\ + colorscale + Sets the fill gradient colors as a color scale. The + color scale is interpreted as a gradient applied in the + direction specified by "orientation", from the lowest + to the highest value of the scatter plot along that + axis, or from the center to the most distant point from + it, if orientation is "radial". + start + Sets the gradient start value. It is given as the + absolute position on the axis determined by the + orientiation. E.g., if orientation is "horizontal", the + gradient will be horizontal and start from the + x-position given by start. If omitted, the gradient + starts at the lowest value of the trace along the + respective axis. Ignored if orientation is "radial". + stop + Sets the gradient end value. It is given as the + absolute position on the axis determined by the + orientiation. E.g., if orientation is "horizontal", the + gradient will be horizontal and end at the x-position + given by end. If omitted, the gradient ends at the + highest value of the trace along the respective axis. + Ignored if orientation is "radial". + type + Sets the type/orientation of the color gradient for the + fill. Defaults to "none". + """ + + def __init__( + self, arg=None, colorscale=None, start=None, stop=None, type=None, **kwargs + ): + """ + Construct a new Fillgradient object + + Sets a fill gradient. If not specified, the fillcolor is used + instead. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Fillgradient` + colorscale + Sets the fill gradient colors as a color scale. The + color scale is interpreted as a gradient applied in the + direction specified by "orientation", from the lowest + to the highest value of the scatter plot along that + axis, or from the center to the most distant point from + it, if orientation is "radial". + start + Sets the gradient start value. It is given as the + absolute position on the axis determined by the + orientiation. E.g., if orientation is "horizontal", the + gradient will be horizontal and start from the + x-position given by start. If omitted, the gradient + starts at the lowest value of the trace along the + respective axis. Ignored if orientation is "radial". + stop + Sets the gradient end value. It is given as the + absolute position on the axis determined by the + orientiation. E.g., if orientation is "horizontal", the + gradient will be horizontal and end at the x-position + given by end. If omitted, the gradient ends at the + highest value of the trace along the respective axis. + Ignored if orientation is "radial". + type + Sets the type/orientation of the color gradient for the + fill. Defaults to "none". + + Returns + ------- + Fillgradient + """ + super().__init__("fillgradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Fillgradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Fillgradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("colorscale", arg, colorscale) + self._set_property("start", arg, start) + self._set_property("stop", arg, stop) + self._set_property("type", arg, type) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillpattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillpattern.py new file mode 100644 index 0000000..f333974 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_fillpattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Fillpattern(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.fillpattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Fillpattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Fillpattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Fillpattern + """ + super().__init__("fillpattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Fillpattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Fillpattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_hoverlabel.py new file mode 100644 index 0000000..e7ff803 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_legendgrouptitle.py new file mode 100644 index 0000000..fabbee3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_line.py new file mode 100644 index 0000000..872923d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_line.py @@ -0,0 +1,310 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.line" + _valid_props = { + "backoff", + "backoffsrc", + "color", + "dash", + "shape", + "simplify", + "smoothing", + "width", + } + + @property + def backoff(self): + """ + Sets the line back off from the end point of the nth line + segment (in px). This option is useful e.g. to avoid overlap + with arrowhead markers. With "auto" the lines would trim before + markers if `marker.angleref` is set to "previous". + + The 'backoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["backoff"] + + @backoff.setter + def backoff(self, val): + self["backoff"] = val + + @property + def backoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `backoff`. + + The 'backoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["backoffsrc"] + + @backoffsrc.setter + def backoffsrc(self, val): + self["backoffsrc"] = val + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def shape(self): + """ + Determines the line shape. With "spline" the lines are drawn + using spline interpolation. The other available values + correspond to step-wise line shapes. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'spline', 'hv', 'vh', 'hvh', 'vhv'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def simplify(self): + """ + Simplifies lines by removing nearly-collinear points. When + transitioning lines, it may be desirable to disable this so + that the number of points along the resulting SVG path is + unaffected. + + The 'simplify' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["simplify"] + + @simplify.setter + def simplify(self, val): + self["simplify"] = val + + @property + def smoothing(self): + """ + Has an effect only if `shape` is set to "spline" Sets the + amount of smoothing. 0 corresponds to no smoothing (equivalent + to a "linear" shape). + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + simplify + Simplifies lines by removing nearly-collinear points. + When transitioning lines, it may be desirable to + disable this so that the number of points along the + resulting SVG path is unaffected. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + backoff=None, + backoffsrc=None, + color=None, + dash=None, + shape=None, + simplify=None, + smoothing=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter.Line` + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + simplify + Simplifies lines by removing nearly-collinear points. + When transitioning lines, it may be desirable to + disable this so that the number of points along the + resulting SVG path is unaffected. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("backoff", arg, backoff) + self._set_property("backoffsrc", arg, backoffsrc) + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("shape", arg, shape) + self._set_property("simplify", arg, simplify) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_marker.py new file mode 100644 index 0000000..3543558 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_marker.py @@ -0,0 +1,1130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.marker" + _valid_props = { + "angle", + "angleref", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "gradient", + "line", + "maxdisplayed", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "standoff", + "standoffsrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def angleref(self): + """ + Sets the reference for marker angle. With "previous", angle 0 + points along the line from the previous point to this one. With + "up", angle 0 points toward the top of the screen. + + The 'angleref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['previous', 'up'] + + Returns + ------- + Any + """ + return self["angleref"] + + @angleref.setter + def angleref(self, val): + self["angleref"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatter.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.Gradient` + - A dict of string/value properties that will be passed + to the Gradient constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.Gradient + """ + return self["gradient"] + + @gradient.setter + def gradient(self, val): + self["gradient"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxdisplayed(self): + """ + Sets a maximum number of points to be drawn on the graph. 0 + corresponds to no limit. + + The 'maxdisplayed' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["maxdisplayed"] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self["maxdisplayed"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def standoff(self): + """ + Moves the marker away from the data point in the direction of + `angle` (in px). This can be useful for example if you have + another marker at this location and you want to point an + arrowhead marker at it. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def standoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `standoff`. + + The 'standoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["standoffsrc"] + + @standoffsrc.setter + def standoffsrc(self, val): + self["standoffsrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatter.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scatter.marker.Gradient` + instance or dict with compatible properties + line + :class:`plotly.graph_objects.scatter.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + angleref=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + standoff=None, + standoffsrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Marker` + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatter.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scatter.marker.Gradient` + instance or dict with compatible properties + line + :class:`plotly.graph_objects.scatter.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("angleref", arg, angleref) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("gradient", arg, gradient) + self._set_property("line", arg, line) + self._set_property("maxdisplayed", arg, maxdisplayed) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("standoff", arg, standoff) + self._set_property("standoffsrc", arg, standoffsrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_selected.py new file mode 100644 index 0000000..d8f7e1d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatter.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatter.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatter.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatter.selected.Textfont` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Selected` + marker + :class:`plotly.graph_objects.scatter.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatter.selected.Textfont` + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_stream.py new file mode 100644 index 0000000..6ba740d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_textfont.py new file mode 100644 index 0000000..7957629 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_unselected.py new file mode 100644 index 0000000..e96e33b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scatter" + _path_str = "scatter.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatter.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatter.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatter.unselected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatter.unselected.Textfon + t` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.Unselected` + marker + :class:`plotly.graph_objects.scatter.unselected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatter.unselected.Textfon + t` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/_font.py new file mode 100644 index 0000000..1abdf82 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter.hoverlabel" + _path_str = "scatter.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/_font.py new file mode 100644 index 0000000..fbc6a1a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter.legendgrouptitle" + _path_str = "scatter.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter.legend + grouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/__init__.py new file mode 100644 index 0000000..6cfc468 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._gradient import Gradient + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._gradient.Gradient", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_colorbar.py new file mode 100644 index 0000000..69d2530 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker" + _path_str = "scatter.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scatter.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scatter.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatter.marker + .colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + scatter.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatter.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatter.marker.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatter.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatter.marker.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_gradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_gradient.py new file mode 100644 index 0000000..129ea67 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_gradient.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker" + _path_str = "scatter.marker.gradient" + _valid_props = {"color", "colorsrc", "type", "typesrc"} + + @property + def color(self): + """ + Sets the final color of the gradient fill: the center color for + radial, the right for horizontal, or the bottom for vertical. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def type(self): + """ + Sets the type of gradient used to fill the markers + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def typesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `type`. + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["typesrc"] + + @typesrc.setter + def typesrc(self, val): + self["typesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, type=None, typesrc=None, **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.marker.Gradient` + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + + Returns + ------- + Gradient + """ + super().__init__("gradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.Gradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.Gradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("type", arg, type) + self._set_property("typesrc", arg, typesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_line.py new file mode 100644 index 0000000..4d77c65 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker" + _path_str = "scatter.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatter.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..979d2b7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker.colorbar" + _path_str = "scatter.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..17996eb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker.colorbar" + _path_str = "scatter.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_title.py new file mode 100644 index 0000000..381a749 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker.colorbar" + _path_str = "scatter.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/_font.py new file mode 100644 index 0000000..6d20253 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter.marker.colorbar.title" + _path_str = "scatter.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter.marker + .colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_marker.py new file mode 100644 index 0000000..6eb0a98 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatter.selected" + _path_str = "scatter.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_textfont.py new file mode 100644 index 0000000..75424c1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter.selected" + _path_str = "scatter.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_marker.py new file mode 100644 index 0000000..dce5658 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatter.unselected" + _path_str = "scatter.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_textfont.py new file mode 100644 index 0000000..63e1707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter.unselected" + _path_str = "scatter.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter.unselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/__init__.py new file mode 100644 index 0000000..e28bc44 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/__init__.py @@ -0,0 +1,38 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._error_x import ErrorX + from ._error_y import ErrorY + from ._error_z import ErrorZ + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._projection import Projection + from ._stream import Stream + from ._textfont import Textfont + from . import hoverlabel + from . import legendgrouptitle + from . import line + from . import marker + from . import projection +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".line", ".marker", ".projection"], + [ + "._error_x.ErrorX", + "._error_y.ErrorY", + "._error_z.ErrorZ", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._projection.Projection", + "._stream.Stream", + "._textfont.Textfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_x.py new file mode 100644 index 0000000..1fd5bd2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_x.py @@ -0,0 +1,503 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.error_x" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "copy_zstyle", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def copy_zstyle(self): + """ + The 'copy_zstyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["copy_zstyle"] + + @copy_zstyle.setter + def copy_zstyle(self, val): + self["copy_zstyle"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_zstyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.ErrorX` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super().__init__("error_x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.ErrorX +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.ErrorX`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("copy_zstyle", arg, copy_zstyle) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_y.py new file mode 100644 index 0000000..87c1a93 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_y.py @@ -0,0 +1,503 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.error_y" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "copy_zstyle", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def copy_zstyle(self): + """ + The 'copy_zstyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["copy_zstyle"] + + @copy_zstyle.setter + def copy_zstyle(self, val): + self["copy_zstyle"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_zstyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.ErrorY` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_zstyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super().__init__("error_y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.ErrorY +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.ErrorY`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("copy_zstyle", arg, copy_zstyle) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_z.py new file mode 100644 index 0000000..cdfd115 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_error_z.py @@ -0,0 +1,480 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorZ(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.error_z" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorZ object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.ErrorZ` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorZ + """ + super().__init__("error_z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.ErrorZ +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.ErrorZ`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_hoverlabel.py new file mode 100644 index 0000000..efb8616 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter3d.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_legendgrouptitle.py new file mode 100644 index 0000000..35ef9ea --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter3d.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_line.py new file mode 100644 index 0000000..d1d7234 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_line.py @@ -0,0 +1,592 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "dash", + "reversescale", + "showscale", + "width", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in `line.color` is set + to a numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `line.color`) or the bounds + set in `line.cmin` and `line.cmax` Has an effect only if in + `line.color` is set to a numerical array. Defaults to `false` + when `line.cmin` and `line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `line.color` is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmin` must + be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `line.cmin` + and/or `line.cmax` to be equidistant to this point. Has an + effect only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color`. Has no + effect when `line.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `line.color` is set to a numerical array. Value should have + the same units as in `line.color` and if set, `line.cmax` must + be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the line color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to `line.cmin` + and `line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatter3d.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.line.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scatter3d.line.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `line.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `line.cmin` and `line.cmax`. Alternatively, `colorscale` may be + a palette name string of the following list: Blackbody,Bluered, + Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portla + nd,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def dash(self): + """ + Sets the dash style of the lines. + + The 'dash' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', + 'solid'] + + Returns + ------- + Any + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `line.color` is set to a numerical array. If true, `line.cmin` + will correspond to the last color in the array and `line.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `line.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has an + effect only if in `line.color` is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color` is + set to a numerical array. Value should have the same + units as in `line.color`. Has no effect when + `line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets the line color. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatter3d.line.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `line.cmin` and `line.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + dash + Sets the dash style of the lines. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color` is set to a numerical array. If + true, `line.cmin` will correspond to the last color in + the array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color` is + set to a numerical array. + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + dash=None, + reversescale=None, + showscale=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `line.colorscale`. Has an effect only if in + `line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `line.color`) + or the bounds set in `line.cmin` and `line.cmax` Has an + effect only if in `line.color` is set to a numerical + array. Defaults to `false` when `line.cmin` and + `line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `line.cmin` and/or `line.cmax` to be equidistant to + this point. Has an effect only if in `line.color` is + set to a numerical array. Value should have the same + units as in `line.color`. Has no effect when + `line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `line.color` is set to a numerical array. + Value should have the same units as in `line.color` and + if set, `line.cmax` must be set as well. + color + Sets the line color. It accepts either a specific color + or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `line.cmin` and `line.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatter3d.line.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `line.cmin` and `line.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + dash + Sets the dash style of the lines. + reversescale + Reverses the color mapping if true. Has an effect only + if in `line.color` is set to a numerical array. If + true, `line.cmin` will correspond to the last color in + the array and `line.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `line.color` is + set to a numerical array. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("dash", arg, dash) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_marker.py new file mode 100644 index 0000000..7f4e422 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_marker.py @@ -0,0 +1,810 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "line", + "opacity", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "symbol", + "symbolsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatter3d.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scatter3d.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatter3d.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. Note that the marker opacity for + scatter3d traces must be a scalar value for performance + reasons. To set a blending opacity value (i.e. which is not + transparent), set "marker.color" to an rgba color and use its + alpha channel. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['circle', 'circle-open', 'cross', 'diamond', + 'diamond-open', 'square', 'square-open', 'x'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatter3d.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.scatter3d.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. Note that the marker opacity + for scatter3d traces must be a scalar value for + performance reasons. To set a blending opacity value + (i.e. which is not transparent), set "marker.color" to + an rgba color and use its alpha channel. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatter3d.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.scatter3d.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. Note that the marker opacity + for scatter3d traces must be a scalar value for + performance reasons. To set a blending opacity value + (i.e. which is not transparent), set "marker.color" to + an rgba color and use its alpha channel. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_projection.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_projection.py new file mode 100644 index 0000000..de02e0c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_projection.py @@ -0,0 +1,132 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Projection(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.projection" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.projection.X` + - A dict of string/value properties that will be passed + to the X constructor + + Returns + ------- + plotly.graph_objs.scatter3d.projection.X + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.projection.Y` + - A dict of string/value properties that will be passed + to the Y constructor + + Returns + ------- + plotly.graph_objs.scatter3d.projection.Y + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.projection.Z` + - A dict of string/value properties that will be passed + to the Z constructor + + Returns + ------- + plotly.graph_objs.scatter3d.projection.Z + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + :class:`plotly.graph_objects.scatter3d.projection.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.scatter3d.projection.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.scatter3d.projection.Z` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Projection object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Projection` + x + :class:`plotly.graph_objects.scatter3d.projection.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.scatter3d.projection.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.scatter3d.projection.Z` + instance or dict with compatible properties + + Returns + ------- + Projection + """ + super().__init__("projection") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Projection +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Projection`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_stream.py new file mode 100644 index 0000000..382456f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_textfont.py new file mode 100644 index 0000000..6d36523 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/_textfont.py @@ -0,0 +1,400 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d" + _path_str = "scatter3d.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "size", + "sizesrc", + "style", + "stylesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/_font.py new file mode 100644 index 0000000..3edf8ed --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.hoverlabel" + _path_str = "scatter3d.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/_font.py new file mode 100644 index 0000000..95c7ad1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.legendgrouptitle" + _path_str = "scatter3d.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.lege + ndgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/__init__.py new file mode 100644 index 0000000..5e06f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/_colorbar.py new file mode 100644 index 0000000..b2b308e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.line" + _path_str = "scatter3d.line.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scatter3d.line.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatter3d.line + .colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + scatter3d.line.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scatter3d.line.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatter3d.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r3d.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter3d.line.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatter3d.line.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.line.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatter3d.line. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r3d.line.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter3d.line.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatter3d.line.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.line.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.line.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py new file mode 100644 index 0000000..2d5833c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.line.colorbar" + _path_str = "scatter3d.line.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.line.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py new file mode 100644 index 0000000..66e80c3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.line.colorbar" + _path_str = "scatter3d.line.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_title.py new file mode 100644 index 0000000..7bcfe28 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.line.colorbar" + _path_str = "scatter3d.line.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter3d.line.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.line.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py new file mode 100644 index 0000000..603e087 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/line/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.line.colorbar.title" + _path_str = "scatter3d.line.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.line + .colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.line.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.line.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/__init__.py new file mode 100644 index 0000000..e0fbf0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_colorbar.py new file mode 100644 index 0000000..f362a2b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.marker" + _path_str = "scatter3d.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatter3d.mark + er.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + scatter3d.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatter3d.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r3d.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter3d.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatter3d.marker.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatter3d.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + r3d.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scatter3d.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatter3d.marker.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_line.py new file mode 100644 index 0000000..50011a6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/_line.py @@ -0,0 +1,518 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.marker" + _path_str = "scatter3d.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatter3d.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..7861266 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.marker.colorbar" + _path_str = "scatter3d.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..5c95cfa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.marker.colorbar" + _path_str = "scatter3d.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_title.py new file mode 100644 index 0000000..1b2aafe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.marker.colorbar" + _path_str = "scatter3d.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatter3d.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py new file mode 100644 index 0000000..53344ff --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.marker.colorbar.title" + _path_str = "scatter3d.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatter3d.mark + er.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/__init__.py new file mode 100644 index 0000000..3802eba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._x import X + from ._y import Y + from ._z import Z +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._x.X", "._y.Y", "._z.Z"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_x.py new file mode 100644 index 0000000..2094583 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_x.py @@ -0,0 +1,128 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.projection" + _path_str = "scatter3d.projection.x" + _valid_props = {"opacity", "scale", "show"} + + @property + def opacity(self): + """ + Sets the projection color. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def scale(self): + """ + Sets the scale factor determining the size of the projection + marker points. + + The 'scale' property is a number and may be specified as: + - An int or float in the interval [0, 10] + + Returns + ------- + int|float + """ + return self["scale"] + + @scale.setter + def scale(self, val): + self["scale"] = val + + @property + def show(self): + """ + Sets whether or not projections are shown along the x axis. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the x + axis. + """ + + def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.projection.X` + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the x + axis. + + Returns + ------- + X + """ + super().__init__("x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.projection.X +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.projection.X`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._set_property("scale", arg, scale) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_y.py new file mode 100644 index 0000000..fb4d7df --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_y.py @@ -0,0 +1,128 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.projection" + _path_str = "scatter3d.projection.y" + _valid_props = {"opacity", "scale", "show"} + + @property + def opacity(self): + """ + Sets the projection color. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def scale(self): + """ + Sets the scale factor determining the size of the projection + marker points. + + The 'scale' property is a number and may be specified as: + - An int or float in the interval [0, 10] + + Returns + ------- + int|float + """ + return self["scale"] + + @scale.setter + def scale(self, val): + self["scale"] = val + + @property + def show(self): + """ + Sets whether or not projections are shown along the y axis. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the y + axis. + """ + + def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.projection.Y` + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the y + axis. + + Returns + ------- + Y + """ + super().__init__("y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.projection.Y +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.projection.Y`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._set_property("scale", arg, scale) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_z.py new file mode 100644 index 0000000..16655eb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatter3d/projection/_z.py @@ -0,0 +1,128 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + _parent_path_str = "scatter3d.projection" + _path_str = "scatter3d.projection.z" + _valid_props = {"opacity", "scale", "show"} + + @property + def opacity(self): + """ + Sets the projection color. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def scale(self): + """ + Sets the scale factor determining the size of the projection + marker points. + + The 'scale' property is a number and may be specified as: + - An int or float in the interval [0, 10] + + Returns + ------- + int|float + """ + return self["scale"] + + @scale.setter + def scale(self, val): + self["scale"] = val + + @property + def show(self): + """ + Sets whether or not projections are shown along the z axis. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the z + axis. + """ + + def __init__(self, arg=None, opacity=None, scale=None, show=None, **kwargs): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatter3d.projection.Z` + opacity + Sets the projection color. + scale + Sets the scale factor determining the size of the + projection marker points. + show + Sets whether or not projections are shown along the z + axis. + + Returns + ------- + Z + """ + super().__init__("z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatter3d.projection.Z +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatter3d.projection.Z`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._set_property("scale", arg, scale) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/__init__.py new file mode 100644 index 0000000..55ee707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_hoverlabel.py new file mode 100644 index 0000000..dc13e02 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_legendgrouptitle.py new file mode 100644 index 0000000..ded5649 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_line.py new file mode 100644 index 0000000..0aa2e06 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_line.py @@ -0,0 +1,277 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.line" + _valid_props = { + "backoff", + "backoffsrc", + "color", + "dash", + "shape", + "smoothing", + "width", + } + + @property + def backoff(self): + """ + Sets the line back off from the end point of the nth line + segment (in px). This option is useful e.g. to avoid overlap + with arrowhead markers. With "auto" the lines would trim before + markers if `marker.angleref` is set to "previous". + + The 'backoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["backoff"] + + @backoff.setter + def backoff(self, val): + self["backoff"] = val + + @property + def backoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `backoff`. + + The 'backoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["backoffsrc"] + + @backoffsrc.setter + def backoffsrc(self, val): + self["backoffsrc"] = val + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def shape(self): + """ + Determines the line shape. With "spline" the lines are drawn + using spline interpolation. The other available values + correspond to step-wise line shapes. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'spline'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def smoothing(self): + """ + Has an effect only if `shape` is set to "spline" Sets the + amount of smoothing. 0 corresponds to no smoothing (equivalent + to a "linear" shape). + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + backoff=None, + backoffsrc=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Line` + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("backoff", arg, backoff) + self._set_property("backoffsrc", arg, backoffsrc) + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("shape", arg, shape) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_marker.py new file mode 100644 index 0000000..3dfb1f7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_marker.py @@ -0,0 +1,1130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.marker" + _valid_props = { + "angle", + "angleref", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "gradient", + "line", + "maxdisplayed", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "standoff", + "standoffsrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def angleref(self): + """ + Sets the reference for marker angle. With "previous", angle 0 + points along the line from the previous point to this one. With + "up", angle 0 points toward the top of the screen. + + The 'angleref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['previous', 'up'] + + Returns + ------- + Any + """ + return self["angleref"] + + @angleref.setter + def angleref(self, val): + self["angleref"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattercarpet.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.Gradient` + - A dict of string/value properties that will be passed + to the Gradient constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.Gradient + """ + return self["gradient"] + + @gradient.setter + def gradient(self, val): + self["gradient"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxdisplayed(self): + """ + Sets a maximum number of points to be drawn on the graph. 0 + corresponds to no limit. + + The 'maxdisplayed' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["maxdisplayed"] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self["maxdisplayed"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def standoff(self): + """ + Moves the marker away from the data point in the direction of + `angle` (in px). This can be useful for example if you have + another marker at this location and you want to point an + arrowhead marker at it. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def standoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `standoff`. + + The 'standoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["standoffsrc"] + + @standoffsrc.setter + def standoffsrc(self, val): + self["standoffsrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattercarpet.marker.Color + Bar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scattercarpet.marker.Gradi + ent` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scattercarpet.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + angleref=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + standoff=None, + standoffsrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Marker` + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattercarpet.marker.Color + Bar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scattercarpet.marker.Gradi + ent` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scattercarpet.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("angleref", arg, angleref) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("gradient", arg, gradient) + self._set_property("line", arg, line) + self._set_property("maxdisplayed", arg, maxdisplayed) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("standoff", arg, standoff) + self._set_property("standoffsrc", arg, standoffsrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_selected.py new file mode 100644 index 0000000..c92d8b3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattercarpet.selected.Mar + ker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattercarpet.selected.Tex + tfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Selected` + marker + :class:`plotly.graph_objects.scattercarpet.selected.Mar + ker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattercarpet.selected.Tex + tfont` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_stream.py new file mode 100644 index 0000000..d1b93a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_textfont.py new file mode 100644 index 0000000..3deda0f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_unselected.py new file mode 100644 index 0000000..ab71af9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet" + _path_str = "scattercarpet.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattercarpet.unselected.M + arker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattercarpet.unselected.T + extfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.Unselected` + marker + :class:`plotly.graph_objects.scattercarpet.unselected.M + arker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattercarpet.unselected.T + extfont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/_font.py new file mode 100644 index 0000000..232ffa7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.hoverlabel" + _path_str = "scattercarpet.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/_font.py new file mode 100644 index 0000000..083f9ec --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.legendgrouptitle" + _path_str = "scattercarpet.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/__init__.py new file mode 100644 index 0000000..6cfc468 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._gradient import Gradient + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._gradient.Gradient", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_colorbar.py new file mode 100644 index 0000000..1d5c07f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker" + _path_str = "scattercarpet.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattercarpet. + marker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + scattercarpet.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattercarpet.m + arker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rcarpet.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattercarpet.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattercarpet.marker.color + bar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattercarpet.m + arker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rcarpet.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattercarpet.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattercarpet.marker.color + bar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_gradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_gradient.py new file mode 100644 index 0000000..1fe30ae --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_gradient.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker" + _path_str = "scattercarpet.marker.gradient" + _valid_props = {"color", "colorsrc", "type", "typesrc"} + + @property + def color(self): + """ + Sets the final color of the gradient fill: the center color for + radial, the right for horizontal, or the bottom for vertical. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def type(self): + """ + Sets the type of gradient used to fill the markers + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def typesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `type`. + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["typesrc"] + + @typesrc.setter + def typesrc(self, val): + self["typesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, type=None, typesrc=None, **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.Gradient` + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + + Returns + ------- + Gradient + """ + super().__init__("gradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.Gradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.Gradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("type", arg, type) + self._set_property("typesrc", arg, typesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_line.py new file mode 100644 index 0000000..bc682af --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker" + _path_str = "scattercarpet.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattercarpet.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattercarpet.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..b831738 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker.colorbar" + _path_str = "scattercarpet.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..6edaabe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker.colorbar" + _path_str = "scattercarpet.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py new file mode 100644 index 0000000..c8032d9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker.colorbar" + _path_str = "scattercarpet.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattercarpet.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py new file mode 100644 index 0000000..33b501c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.marker.colorbar.title" + _path_str = "scattercarpet.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + marker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_marker.py new file mode 100644 index 0000000..1af34aa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.selected" + _path_str = "scattercarpet.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_textfont.py new file mode 100644 index 0000000..10dc095 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.selected" + _path_str = "scattercarpet.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_marker.py new file mode 100644 index 0000000..4873833 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.unselected" + _path_str = "scattercarpet.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_textfont.py new file mode 100644 index 0000000..02f1e9d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattercarpet/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattercarpet.unselected" + _path_str = "scattercarpet.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattercarpet. + unselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattercarpet.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattercarpet.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/__init__.py new file mode 100644 index 0000000..55ee707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_hoverlabel.py new file mode 100644 index 0000000..249bc9c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattergeo.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_legendgrouptitle.py new file mode 100644 index 0000000..ba86fda --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattergeo.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_line.py new file mode 100644 index 0000000..5151208 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_marker.py new file mode 100644 index 0000000..3db78be --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_marker.py @@ -0,0 +1,1106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.marker" + _valid_props = { + "angle", + "angleref", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "gradient", + "line", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "standoff", + "standoffsrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def angleref(self): + """ + Sets the reference for marker angle. With "previous", angle 0 + points along the line from the previous point to this one. With + "up", angle 0 points toward the top of the screen. With + "north", angle 0 points north based on the current map + projection. + + The 'angleref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['previous', 'up', 'north'] + + Returns + ------- + Any + """ + return self["angleref"] + + @angleref.setter + def angleref(self, val): + self["angleref"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattergeo.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.Gradient` + - A dict of string/value properties that will be passed + to the Gradient constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.Gradient + """ + return self["gradient"] + + @gradient.setter + def gradient(self, val): + self["gradient"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def standoff(self): + """ + Moves the marker away from the data point in the direction of + `angle` (in px). This can be useful for example if you have + another marker at this location and you want to point an + arrowhead marker at it. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def standoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `standoff`. + + The 'standoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["standoffsrc"] + + @standoffsrc.setter + def standoffsrc(self, val): + self["standoffsrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. With "north", angle 0 points north based + on the current map projection. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattergeo.marker.ColorBar + ` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scattergeo.marker.Gradient + ` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scattergeo.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + angleref=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + standoff=None, + standoffsrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Marker` + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. With "north", angle 0 points north based + on the current map projection. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattergeo.marker.ColorBar + ` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scattergeo.marker.Gradient + ` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scattergeo.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("angleref", arg, angleref) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("gradient", arg, gradient) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("standoff", arg, standoff) + self._set_property("standoffsrc", arg, standoffsrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_selected.py new file mode 100644 index 0000000..efa633a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattergeo.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattergeo.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattergeo.selected.Marker + ` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergeo.selected.Textfo + nt` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Selected` + marker + :class:`plotly.graph_objects.scattergeo.selected.Marker + ` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergeo.selected.Textfo + nt` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_stream.py new file mode 100644 index 0000000..18aea3e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_textfont.py new file mode 100644 index 0000000..8a56df5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_unselected.py new file mode 100644 index 0000000..0904ecc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo" + _path_str = "scattergeo.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattergeo.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattergeo.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattergeo.unselected.Mark + er` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergeo.unselected.Text + font` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.Unselected` + marker + :class:`plotly.graph_objects.scattergeo.unselected.Mark + er` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergeo.unselected.Text + font` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/_font.py new file mode 100644 index 0000000..730d1d4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.hoverlabel" + _path_str = "scattergeo.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/_font.py new file mode 100644 index 0000000..4dfd8a0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.legendgrouptitle" + _path_str = "scattergeo.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergeo.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/__init__.py new file mode 100644 index 0000000..6cfc468 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._gradient import Gradient + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._gradient.Gradient", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_colorbar.py new file mode 100644 index 0000000..6b0e321 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker" + _path_str = "scattergeo.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattergeo.mar + ker.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + scattergeo.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattergeo.mark + er.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgeo.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergeo.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattergeo.marker.colorbar + .Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattergeo.mark + er.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgeo.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergeo.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattergeo.marker.colorbar + .Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_gradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_gradient.py new file mode 100644 index 0000000..abda79f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_gradient.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker" + _path_str = "scattergeo.marker.gradient" + _valid_props = {"color", "colorsrc", "type", "typesrc"} + + @property + def color(self): + """ + Sets the final color of the gradient fill: the center color for + radial, the right for horizontal, or the bottom for vertical. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def type(self): + """ + Sets the type of gradient used to fill the markers + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def typesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `type`. + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["typesrc"] + + @typesrc.setter + def typesrc(self, val): + self["typesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, type=None, typesrc=None, **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.marker.Gradient` + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + + Returns + ------- + Gradient + """ + super().__init__("gradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.Gradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.Gradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("type", arg, type) + self._set_property("typesrc", arg, typesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_line.py new file mode 100644 index 0000000..c721fcd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker" + _path_str = "scattergeo.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattergeo.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..81b1718 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker.colorbar" + _path_str = "scattergeo.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..af8aad9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker.colorbar" + _path_str = "scattergeo.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_title.py new file mode 100644 index 0000000..8ca1156 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker.colorbar" + _path_str = "scattergeo.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattergeo.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py new file mode 100644 index 0000000..ace978f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.marker.colorbar.title" + _path_str = "scattergeo.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergeo.mar + ker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_marker.py new file mode 100644 index 0000000..e3c2b9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.selected" + _path_str = "scattergeo.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_textfont.py new file mode 100644 index 0000000..d3fa7e8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.selected" + _path_str = "scattergeo.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_marker.py new file mode 100644 index 0000000..7249a60 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.unselected" + _path_str = "scattergeo.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergeo.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_textfont.py new file mode 100644 index 0000000..c076f08 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergeo/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergeo.unselected" + _path_str = "scattergeo.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergeo.uns + elected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergeo.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergeo.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/__init__.py new file mode 100644 index 0000000..f3ca4ee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/__init__.py @@ -0,0 +1,38 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._error_x import ErrorX + from ._error_y import ErrorY + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._error_x.ErrorX", + "._error_y.ErrorY", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_x.py new file mode 100644 index 0000000..b2efa2a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_x.py @@ -0,0 +1,503 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorX(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.error_x" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "copy_ystyle", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def copy_ystyle(self): + """ + The 'copy_ystyle' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["copy_ystyle"] + + @copy_ystyle.setter + def copy_ystyle(self, val): + self["copy_ystyle"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + copy_ystyle=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorX object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.ErrorX` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + copy_ystyle + + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorX + """ + super().__init__("error_x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.ErrorX +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.ErrorX`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("copy_ystyle", arg, copy_ystyle) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_y.py new file mode 100644 index 0000000..376febb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_error_y.py @@ -0,0 +1,480 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ErrorY(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.error_y" + _valid_props = { + "array", + "arrayminus", + "arrayminussrc", + "arraysrc", + "color", + "symmetric", + "thickness", + "traceref", + "tracerefminus", + "type", + "value", + "valueminus", + "visible", + "width", + } + + @property + def array(self): + """ + Sets the data corresponding the length of each error bar. + Values are plotted relative to the underlying data. + + The 'array' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["array"] + + @array.setter + def array(self, val): + self["array"] = val + + @property + def arrayminus(self): + """ + Sets the data corresponding the length of each error bar in the + bottom (left) direction for vertical (horizontal) bars Values + are plotted relative to the underlying data. + + The 'arrayminus' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["arrayminus"] + + @arrayminus.setter + def arrayminus(self, val): + self["arrayminus"] = val + + @property + def arrayminussrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + + The 'arrayminussrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arrayminussrc"] + + @arrayminussrc.setter + def arrayminussrc(self, val): + self["arrayminussrc"] = val + + @property + def arraysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `array`. + + The 'arraysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["arraysrc"] + + @arraysrc.setter + def arraysrc(self, val): + self["arraysrc"] = val + + @property + def color(self): + """ + Sets the stroke color of the error bars. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def symmetric(self): + """ + Determines whether or not the error bars have the same length + in both direction (top/bottom for vertical bars, left/right for + horizontal bars. + + The 'symmetric' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["symmetric"] + + @symmetric.setter + def symmetric(self, val): + self["symmetric"] = val + + @property + def thickness(self): + """ + Sets the thickness (in px) of the error bars. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def traceref(self): + """ + The 'traceref' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["traceref"] + + @traceref.setter + def traceref(self, val): + self["traceref"] = val + + @property + def tracerefminus(self): + """ + The 'tracerefminus' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["tracerefminus"] + + @tracerefminus.setter + def tracerefminus(self, val): + self["tracerefminus"] = val + + @property + def type(self): + """ + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. Set this + constant in `value`. If "percent", the bar lengths correspond + to a percentage of underlying data. Set this percentage in + `value`. If "sqrt", the bar lengths correspond to the square of + the underlying data. If "data", the bar lengths are set with + data set `array`. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['percent', 'constant', 'sqrt', 'data'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def value(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars. + + The 'value' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def valueminus(self): + """ + Sets the value of either the percentage (if `type` is set to + "percent") or the constant (if `type` is set to "constant") + corresponding to the lengths of the error bars in the bottom + (left) direction for vertical (horizontal) bars + + The 'valueminus' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["valueminus"] + + @valueminus.setter + def valueminus(self, val): + self["valueminus"] = val + + @property + def visible(self): + """ + Determines whether or not this set of error bars is visible. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width (in px) of the cross-bar at both ends of the + error bars. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + """ + + def __init__( + self, + arg=None, + array=None, + arrayminus=None, + arrayminussrc=None, + arraysrc=None, + color=None, + symmetric=None, + thickness=None, + traceref=None, + tracerefminus=None, + type=None, + value=None, + valueminus=None, + visible=None, + width=None, + **kwargs, + ): + """ + Construct a new ErrorY object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.ErrorY` + array + Sets the data corresponding the length of each error + bar. Values are plotted relative to the underlying + data. + arrayminus + Sets the data corresponding the length of each error + bar in the bottom (left) direction for vertical + (horizontal) bars Values are plotted relative to the + underlying data. + arrayminussrc + Sets the source reference on Chart Studio Cloud for + `arrayminus`. + arraysrc + Sets the source reference on Chart Studio Cloud for + `array`. + color + Sets the stroke color of the error bars. + symmetric + Determines whether or not the error bars have the same + length in both direction (top/bottom for vertical bars, + left/right for horizontal bars. + thickness + Sets the thickness (in px) of the error bars. + traceref + + tracerefminus + + type + Determines the rule used to generate the error bars. If + "constant", the bar lengths are of a constant value. + Set this constant in `value`. If "percent", the bar + lengths correspond to a percentage of underlying data. + Set this percentage in `value`. If "sqrt", the bar + lengths correspond to the square of the underlying + data. If "data", the bar lengths are set with data set + `array`. + value + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars. + valueminus + Sets the value of either the percentage (if `type` is + set to "percent") or the constant (if `type` is set to + "constant") corresponding to the lengths of the error + bars in the bottom (left) direction for vertical + (horizontal) bars + visible + Determines whether or not this set of error bars is + visible. + width + Sets the width (in px) of the cross-bar at both ends of + the error bars. + + Returns + ------- + ErrorY + """ + super().__init__("error_y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.ErrorY +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.ErrorY`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("array", arg, array) + self._set_property("arrayminus", arg, arrayminus) + self._set_property("arrayminussrc", arg, arrayminussrc) + self._set_property("arraysrc", arg, arraysrc) + self._set_property("color", arg, color) + self._set_property("symmetric", arg, symmetric) + self._set_property("thickness", arg, thickness) + self._set_property("traceref", arg, traceref) + self._set_property("tracerefminus", arg, tracerefminus) + self._set_property("type", arg, type) + self._set_property("value", arg, value) + self._set_property("valueminus", arg, valueminus) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_hoverlabel.py new file mode 100644 index 0000000..cdd1270 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattergl.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_legendgrouptitle.py new file mode 100644 index 0000000..ac54eda --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattergl.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_line.py new file mode 100644 index 0000000..12b641c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_line.py @@ -0,0 +1,158 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.line" + _valid_props = {"color", "dash", "shape", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the style of the lines. + + The 'dash' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', + 'solid'] + + Returns + ------- + Any + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def shape(self): + """ + Determines the line shape. The values correspond to step-wise + line shapes. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'hv', 'vh', 'hvh', 'vhv'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values correspond to + step-wise line shapes. + width + Sets the line width (in px). + """ + + def __init__( + self, arg=None, color=None, dash=None, shape=None, width=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Line` + color + Sets the line color. + dash + Sets the style of the lines. + shape + Determines the line shape. The values correspond to + step-wise line shapes. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("shape", arg, shape) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_marker.py new file mode 100644 index 0000000..c26e398 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_marker.py @@ -0,0 +1,978 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.marker" + _valid_props = { + "angle", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "line", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattergl.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scattergl.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattergl.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattergl.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.scattergl.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Marker` + angle + Sets the marker angle in respect to `angleref`. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattergl.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.scattergl.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_selected.py new file mode 100644 index 0000000..1271ced --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattergl.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattergl.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattergl.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergl.selected.Textfon + t` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Selected` + marker + :class:`plotly.graph_objects.scattergl.selected.Marker` + instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergl.selected.Textfon + t` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_stream.py new file mode 100644 index 0000000..108cc9b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_textfont.py new file mode 100644 index 0000000..ccc8e03 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_textfont.py @@ -0,0 +1,399 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "size", + "sizesrc", + "style", + "stylesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'bold'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_unselected.py new file mode 100644 index 0000000..7c2cd4b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scattergl" + _path_str = "scattergl.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattergl.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattergl.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattergl.unselected.Marke + r` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergl.unselected.Textf + ont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.Unselected` + marker + :class:`plotly.graph_objects.scattergl.unselected.Marke + r` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattergl.unselected.Textf + ont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/_font.py new file mode 100644 index 0000000..9481a51 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.hoverlabel" + _path_str = "scattergl.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/_font.py new file mode 100644 index 0000000..fa358d7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.legendgrouptitle" + _path_str = "scattergl.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergl.lege + ndgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/__init__.py new file mode 100644 index 0000000..e0fbf0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_colorbar.py new file mode 100644 index 0000000..6cb0422 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.marker" + _path_str = "scattergl.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattergl.mark + er.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + scattergl.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattergl.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgl.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergl.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattergl.marker.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattergl.marke + r.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rgl.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattergl.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattergl.marker.colorbar. + Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_line.py new file mode 100644 index 0000000..70e9960 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.marker" + _path_str = "scattergl.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattergl.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..c4aaded --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.marker.colorbar" + _path_str = "scattergl.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..c621d4a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.marker.colorbar" + _path_str = "scattergl.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_title.py new file mode 100644 index 0000000..48a0384 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.marker.colorbar" + _path_str = "scattergl.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattergl.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py new file mode 100644 index 0000000..359d09e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.marker.colorbar.title" + _path_str = "scattergl.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergl.mark + er.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_marker.py new file mode 100644 index 0000000..dbad7a5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.selected" + _path_str = "scattergl.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_textfont.py new file mode 100644 index 0000000..a37e6d9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.selected" + _path_str = "scattergl.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_marker.py new file mode 100644 index 0000000..0d9f1cc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.unselected" + _path_str = "scattergl.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattergl.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_textfont.py new file mode 100644 index 0000000..73d64c9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattergl/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattergl.unselected" + _path_str = "scattergl.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattergl.unse + lected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattergl.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattergl.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/__init__.py new file mode 100644 index 0000000..aaeb5c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/__init__.py @@ -0,0 +1,36 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._cluster import Cluster + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._cluster.Cluster", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_cluster.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_cluster.py new file mode 100644 index 0000000..06e8863 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_cluster.py @@ -0,0 +1,342 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Cluster(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.cluster" + _valid_props = { + "color", + "colorsrc", + "enabled", + "maxzoom", + "opacity", + "opacitysrc", + "size", + "sizesrc", + "step", + "stepsrc", + } + + @property + def color(self): + """ + Sets the color for each cluster step. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def enabled(self): + """ + Determines whether clustering is enabled or disabled. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def maxzoom(self): + """ + Sets the maximum zoom level. At zoom levels equal to or greater + than this, points will never be clustered. + + The 'maxzoom' property is a number and may be specified as: + - An int or float in the interval [0, 24] + + Returns + ------- + int|float + """ + return self["maxzoom"] + + @maxzoom.setter + def maxzoom(self, val): + self["maxzoom"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def size(self): + """ + Sets the size for each cluster step. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def step(self): + """ + Sets how many points it takes to create a cluster or advance to + the next cluster step. Use this in conjunction with arrays for + `size` and / or `color`. If an integer, steps start at + multiples of this number. If an array, each step extends from + the given value until one less than the next value. + + The 'step' property is a number and may be specified as: + - An int or float in the interval [-1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["step"] + + @step.setter + def step(self, val): + self["step"] = val + + @property + def stepsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `step`. + + The 'stepsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stepsrc"] + + @stepsrc.setter + def stepsrc(self, val): + self["stepsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color for each cluster step. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + enabled + Determines whether clustering is enabled or disabled. + maxzoom + Sets the maximum zoom level. At zoom levels equal to or + greater than this, points will never be clustered. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + size + Sets the size for each cluster step. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + step + Sets how many points it takes to create a cluster or + advance to the next cluster step. Use this in + conjunction with arrays for `size` and / or `color`. If + an integer, steps start at multiples of this number. If + an array, each step extends from the given value until + one less than the next value. + stepsrc + Sets the source reference on Chart Studio Cloud for + `step`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + enabled=None, + maxzoom=None, + opacity=None, + opacitysrc=None, + size=None, + sizesrc=None, + step=None, + stepsrc=None, + **kwargs, + ): + """ + Construct a new Cluster object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Cluster` + color + Sets the color for each cluster step. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + enabled + Determines whether clustering is enabled or disabled. + maxzoom + Sets the maximum zoom level. At zoom levels equal to or + greater than this, points will never be clustered. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + size + Sets the size for each cluster step. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + step + Sets how many points it takes to create a cluster or + advance to the next cluster step. Use this in + conjunction with arrays for `size` and / or `color`. If + an integer, steps start at multiples of this number. If + an array, each step extends from the given value until + one less than the next value. + stepsrc + Sets the source reference on Chart Studio Cloud for + `step`. + + Returns + ------- + Cluster + """ + super().__init__("cluster") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Cluster +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Cluster`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("enabled", arg, enabled) + self._set_property("maxzoom", arg, maxzoom) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("step", arg, step) + self._set_property("stepsrc", arg, stepsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_hoverlabel.py new file mode 100644 index 0000000..7e63cfb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattermap.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_legendgrouptitle.py new file mode 100644 index 0000000..0dee4c5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattermap.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_line.py new file mode 100644 index 0000000..6d07e8b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Line` + color + Sets the line color. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_marker.py new file mode 100644 index 0000000..a5612a3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_marker.py @@ -0,0 +1,892 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.marker" + _valid_props = { + "allowoverlap", + "angle", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "symbol", + "symbolsrc", + } + + @property + def allowoverlap(self): + """ + Flag to draw all symbols, even if they overlap. + + The 'allowoverlap' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["allowoverlap"] + + @allowoverlap.setter + def allowoverlap(self, val): + self["allowoverlap"] = val + + @property + def angle(self): + """ + Sets the marker orientation from true North, in degrees + clockwise. When using the "auto" default, no rotation would be + applied in perspective views which is different from using a + zero angle. + + The 'angle' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattermap.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scattermap.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol. Full list: https://www.map.com/maki- + icons/ Note that the array `marker.color` and `marker.size` are + only available for "circle" symbols. + + The 'symbol' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + allowoverlap + Flag to draw all symbols, even if they overlap. + angle + Sets the marker orientation from true North, in degrees + clockwise. When using the "auto" default, no rotation + would be applied in perspective views which is + different from using a zero angle. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattermap.marker.ColorBar + ` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol. Full list: + https://www.map.com/maki-icons/ Note that the array + `marker.color` and `marker.size` are only available for + "circle" symbols. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + allowoverlap=None, + angle=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Marker` + allowoverlap + Flag to draw all symbols, even if they overlap. + angle + Sets the marker orientation from true North, in degrees + clockwise. When using the "auto" default, no rotation + would be applied in perspective views which is + different from using a zero angle. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattermap.marker.ColorBar + ` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol. Full list: + https://www.map.com/maki-icons/ Note that the array + `marker.color` and `marker.size` are only available for + "circle" symbols. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("allowoverlap", arg, allowoverlap) + self._set_property("angle", arg, angle) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_selected.py new file mode 100644 index 0000000..fc36d37 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattermap.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattermap.selected.Marker + ` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Selected` + marker + :class:`plotly.graph_objects.scattermap.selected.Marker + ` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_stream.py new file mode 100644 index 0000000..cb82bb8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_textfont.py new file mode 100644 index 0000000..fda40ac --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_textfont.py @@ -0,0 +1,202 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.textfont" + _valid_props = {"color", "family", "size", "style", "weight"} + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + size=None, + style=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the icon text font (color=map.layer.paint.text-color, + size=map.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_unselected.py new file mode 100644 index 0000000..6911361 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scattermap" + _path_str = "scattermap.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattermap.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattermap.unselected.Mark + er` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.Unselected` + marker + :class:`plotly.graph_objects.scattermap.unselected.Mark + er` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/_font.py new file mode 100644 index 0000000..a6fe495 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.hoverlabel" + _path_str = "scattermap.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/_font.py new file mode 100644 index 0000000..ea1fc04 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.legendgrouptitle" + _path_str = "scattermap.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermap.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/__init__.py new file mode 100644 index 0000000..5e06f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/_colorbar.py new file mode 100644 index 0000000..77f929e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.marker" + _path_str = "scattermap.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scattermap.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scattermap.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scattermap.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattermap.mar + ker.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + scattermap.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scattermap.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scattermap.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattermap.mark + er.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rmap.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattermap.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattermap.marker.colorbar + .Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattermap.mark + er.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rmap.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + scattermap.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattermap.marker.colorbar + .Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..77304fc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.marker.colorbar" + _path_str = "scattermap.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermap.mar + ker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..9185e88 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.marker.colorbar" + _path_str = "scattermap.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermap.mar + ker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_title.py new file mode 100644 index 0000000..3fd7257 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.marker.colorbar" + _path_str = "scattermap.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattermap.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermap.mar + ker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/_font.py new file mode 100644 index 0000000..5fbf794 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.marker.colorbar.title" + _path_str = "scattermap.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermap.mar + ker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/_marker.py new file mode 100644 index 0000000..f7df731 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.selected" + _path_str = "scattermap.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/_marker.py new file mode 100644 index 0000000..b85c1a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermap/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattermap.unselected" + _path_str = "scattermap.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermap.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermap.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermap.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/__init__.py new file mode 100644 index 0000000..aaeb5c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/__init__.py @@ -0,0 +1,36 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._cluster import Cluster + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._cluster.Cluster", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_cluster.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_cluster.py new file mode 100644 index 0000000..c064caf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_cluster.py @@ -0,0 +1,342 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Cluster(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.cluster" + _valid_props = { + "color", + "colorsrc", + "enabled", + "maxzoom", + "opacity", + "opacitysrc", + "size", + "sizesrc", + "step", + "stepsrc", + } + + @property + def color(self): + """ + Sets the color for each cluster step. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def enabled(self): + """ + Determines whether clustering is enabled or disabled. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def maxzoom(self): + """ + Sets the maximum zoom level. At zoom levels equal to or greater + than this, points will never be clustered. + + The 'maxzoom' property is a number and may be specified as: + - An int or float in the interval [0, 24] + + Returns + ------- + int|float + """ + return self["maxzoom"] + + @maxzoom.setter + def maxzoom(self, val): + self["maxzoom"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def size(self): + """ + Sets the size for each cluster step. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def step(self): + """ + Sets how many points it takes to create a cluster or advance to + the next cluster step. Use this in conjunction with arrays for + `size` and / or `color`. If an integer, steps start at + multiples of this number. If an array, each step extends from + the given value until one less than the next value. + + The 'step' property is a number and may be specified as: + - An int or float in the interval [-1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["step"] + + @step.setter + def step(self, val): + self["step"] = val + + @property + def stepsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `step`. + + The 'stepsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stepsrc"] + + @stepsrc.setter + def stepsrc(self, val): + self["stepsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color for each cluster step. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + enabled + Determines whether clustering is enabled or disabled. + maxzoom + Sets the maximum zoom level. At zoom levels equal to or + greater than this, points will never be clustered. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + size + Sets the size for each cluster step. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + step + Sets how many points it takes to create a cluster or + advance to the next cluster step. Use this in + conjunction with arrays for `size` and / or `color`. If + an integer, steps start at multiples of this number. If + an array, each step extends from the given value until + one less than the next value. + stepsrc + Sets the source reference on Chart Studio Cloud for + `step`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + enabled=None, + maxzoom=None, + opacity=None, + opacitysrc=None, + size=None, + sizesrc=None, + step=None, + stepsrc=None, + **kwargs, + ): + """ + Construct a new Cluster object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Cluster` + color + Sets the color for each cluster step. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + enabled + Determines whether clustering is enabled or disabled. + maxzoom + Sets the maximum zoom level. At zoom levels equal to or + greater than this, points will never be clustered. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + size + Sets the size for each cluster step. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + step + Sets how many points it takes to create a cluster or + advance to the next cluster step. Use this in + conjunction with arrays for `size` and / or `color`. If + an integer, steps start at multiples of this number. If + an array, each step extends from the given value until + one less than the next value. + stepsrc + Sets the source reference on Chart Studio Cloud for + `step`. + + Returns + ------- + Cluster + """ + super().__init__("cluster") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Cluster +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Cluster`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("enabled", arg, enabled) + self._set_property("maxzoom", arg, maxzoom) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("step", arg, step) + self._set_property("stepsrc", arg, stepsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_hoverlabel.py new file mode 100644 index 0000000..424c960 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_legendgrouptitle.py new file mode 100644 index 0000000..754d1be --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_line.py new file mode 100644 index 0000000..16aa69c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Line` + color + Sets the line color. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_marker.py new file mode 100644 index 0000000..00c348d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_marker.py @@ -0,0 +1,892 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.marker" + _valid_props = { + "allowoverlap", + "angle", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "symbol", + "symbolsrc", + } + + @property + def allowoverlap(self): + """ + Flag to draw all symbols, even if they overlap. + + The 'allowoverlap' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["allowoverlap"] + + @allowoverlap.setter + def allowoverlap(self, val): + self["allowoverlap"] = val + + @property + def angle(self): + """ + Sets the marker orientation from true North, in degrees + clockwise. When using the "auto" default, no rotation would be + applied in perspective views which is different from using a + zero angle. + + The 'angle' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattermapbox.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol. Full list: https://www.mapbox.com/maki- + icons/ Note that the array `marker.color` and `marker.size` are + only available for "circle" symbols. + + The 'symbol' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + allowoverlap + Flag to draw all symbols, even if they overlap. + angle + Sets the marker orientation from true North, in degrees + clockwise. When using the "auto" default, no rotation + would be applied in perspective views which is + different from using a zero angle. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattermapbox.marker.Color + Bar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol. Full list: + https://www.mapbox.com/maki-icons/ Note that the array + `marker.color` and `marker.size` are only available for + "circle" symbols. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + allowoverlap=None, + angle=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Marker` + allowoverlap + Flag to draw all symbols, even if they overlap. + angle + Sets the marker orientation from true North, in degrees + clockwise. When using the "auto" default, no rotation + would be applied in perspective views which is + different from using a zero angle. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattermapbox.marker.Color + Bar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol. Full list: + https://www.mapbox.com/maki-icons/ Note that the array + `marker.color` and `marker.size` are only available for + "circle" symbols. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("allowoverlap", arg, allowoverlap) + self._set_property("angle", arg, angle) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_selected.py new file mode 100644 index 0000000..e2f9603 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattermapbox.selected.Mar + ker` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Selected` + marker + :class:`plotly.graph_objects.scattermapbox.selected.Mar + ker` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_stream.py new file mode 100644 index 0000000..d28443d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_textfont.py new file mode 100644 index 0000000..7e99b01 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_textfont.py @@ -0,0 +1,202 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.textfont" + _valid_props = {"color", "family", "size", "style", "weight"} + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + size=None, + style=None, + weight=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the icon text font (color=mapbox.layer.paint.text-color, + size=mapbox.layer.layout.text-size). Has an effect only when + `type` is set to "symbol". + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Textfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_unselected.py new file mode 100644 index 0000000..4d67064 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox" + _path_str = "scattermapbox.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattermapbox.unselected.M + arker` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattermapbox.Unselected` + marker + :class:`plotly.graph_objects.scattermapbox.unselected.M + arker` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/_font.py new file mode 100644 index 0000000..c62d8e2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.hoverlabel" + _path_str = "scattermapbox.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/_font.py new file mode 100644 index 0000000..344b825 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.legendgrouptitle" + _path_str = "scattermapbox.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/__init__.py new file mode 100644 index 0000000..5e06f9a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/_colorbar.py new file mode 100644 index 0000000..5203418 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.marker" + _path_str = "scattermapbox.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattermapbox. + marker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + scattermapbox.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattermapbox.m + arker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rmapbox.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattermapbox.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattermapbox.marker.color + bar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattermapbox.m + arker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rmapbox.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattermapbox.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattermapbox.marker.color + bar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..98b197c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.marker.colorbar" + _path_str = "scattermapbox.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..e41d613 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.marker.colorbar" + _path_str = "scattermapbox.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py new file mode 100644 index 0000000..d3846ce --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.marker.colorbar" + _path_str = "scattermapbox.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattermapbox.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py new file mode 100644 index 0000000..c287c6e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.marker.colorbar.title" + _path_str = "scattermapbox.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + marker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/_marker.py new file mode 100644 index 0000000..14bd5d4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.selected" + _path_str = "scattermapbox.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/_marker.py new file mode 100644 index 0000000..2bbe8a6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattermapbox/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattermapbox.unselected" + _path_str = "scattermapbox.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattermapbox. + unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattermapbox.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattermapbox.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/__init__.py new file mode 100644 index 0000000..55ee707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_hoverlabel.py new file mode 100644 index 0000000..81f0a31 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_legendgrouptitle.py new file mode 100644 index 0000000..a4da5c4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.L + egendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_line.py new file mode 100644 index 0000000..ae3d3f2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_line.py @@ -0,0 +1,277 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.line" + _valid_props = { + "backoff", + "backoffsrc", + "color", + "dash", + "shape", + "smoothing", + "width", + } + + @property + def backoff(self): + """ + Sets the line back off from the end point of the nth line + segment (in px). This option is useful e.g. to avoid overlap + with arrowhead markers. With "auto" the lines would trim before + markers if `marker.angleref` is set to "previous". + + The 'backoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["backoff"] + + @backoff.setter + def backoff(self, val): + self["backoff"] = val + + @property + def backoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `backoff`. + + The 'backoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["backoffsrc"] + + @backoffsrc.setter + def backoffsrc(self, val): + self["backoffsrc"] = val + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def shape(self): + """ + Determines the line shape. With "spline" the lines are drawn + using spline interpolation. The other available values + correspond to step-wise line shapes. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'spline'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def smoothing(self): + """ + Has an effect only if `shape` is set to "spline" Sets the + amount of smoothing. 0 corresponds to no smoothing (equivalent + to a "linear" shape). + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + backoff=None, + backoffsrc=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Line` + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("backoff", arg, backoff) + self._set_property("backoffsrc", arg, backoffsrc) + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("shape", arg, shape) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_marker.py new file mode 100644 index 0000000..377e839 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_marker.py @@ -0,0 +1,1130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.marker" + _valid_props = { + "angle", + "angleref", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "gradient", + "line", + "maxdisplayed", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "standoff", + "standoffsrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def angleref(self): + """ + Sets the reference for marker angle. With "previous", angle 0 + points along the line from the previous point to this one. With + "up", angle 0 points toward the top of the screen. + + The 'angleref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['previous', 'up'] + + Returns + ------- + Any + """ + return self["angleref"] + + @angleref.setter + def angleref(self, val): + self["angleref"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatterpolar.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.Gradient` + - A dict of string/value properties that will be passed + to the Gradient constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.Gradient + """ + return self["gradient"] + + @gradient.setter + def gradient(self, val): + self["gradient"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxdisplayed(self): + """ + Sets a maximum number of points to be drawn on the graph. 0 + corresponds to no limit. + + The 'maxdisplayed' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["maxdisplayed"] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self["maxdisplayed"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def standoff(self): + """ + Moves the marker away from the data point in the direction of + `angle` (in px). This can be useful for example if you have + another marker at this location and you want to point an + arrowhead marker at it. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def standoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `standoff`. + + The 'standoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["standoffsrc"] + + @standoffsrc.setter + def standoffsrc(self, val): + self["standoffsrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatterpolar.marker.ColorB + ar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scatterpolar.marker.Gradie + nt` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scatterpolar.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + angleref=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + standoff=None, + standoffsrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Marker` + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatterpolar.marker.ColorB + ar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scatterpolar.marker.Gradie + nt` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scatterpolar.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("angleref", arg, angleref) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("gradient", arg, gradient) + self._set_property("line", arg, line) + self._set_property("maxdisplayed", arg, maxdisplayed) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("standoff", arg, standoff) + self._set_property("standoffsrc", arg, standoffsrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_selected.py new file mode 100644 index 0000000..09902d4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatterpolar.selected.Mark + er` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolar.selected.Text + font` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Selected` + marker + :class:`plotly.graph_objects.scatterpolar.selected.Mark + er` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolar.selected.Text + font` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_stream.py new file mode 100644 index 0000000..094bc94 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_textfont.py new file mode 100644 index 0000000..7e28749 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_unselected.py new file mode 100644 index 0000000..1b9fd77 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar" + _path_str = "scatterpolar.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatterpolar.unselected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolar.unselected.Te + xtfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.Unselected` + marker + :class:`plotly.graph_objects.scatterpolar.unselected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolar.unselected.Te + xtfont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/_font.py new file mode 100644 index 0000000..d178804 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.hoverlabel" + _path_str = "scatterpolar.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/_font.py new file mode 100644 index 0000000..f64a5f7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.legendgrouptitle" + _path_str = "scatterpolar.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.l + egendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/__init__.py new file mode 100644 index 0000000..6cfc468 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._gradient import Gradient + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._gradient.Gradient", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_colorbar.py new file mode 100644 index 0000000..08cb618 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker" + _path_str = "scatterpolar.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatterpolar.m + arker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + scatterpolar.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatterpolar.ma + rker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolar.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolar.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatterpolar.marker.colorb + ar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatterpolar.ma + rker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolar.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolar.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatterpolar.marker.colorb + ar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_gradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_gradient.py new file mode 100644 index 0000000..2688228 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_gradient.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker" + _path_str = "scatterpolar.marker.gradient" + _valid_props = {"color", "colorsrc", "type", "typesrc"} + + @property + def color(self): + """ + Sets the final color of the gradient fill: the center color for + radial, the right for horizontal, or the bottom for vertical. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def type(self): + """ + Sets the type of gradient used to fill the markers + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def typesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `type`. + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["typesrc"] + + @typesrc.setter + def typesrc(self, val): + self["typesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, type=None, typesrc=None, **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.marker.Gradient` + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + + Returns + ------- + Gradient + """ + super().__init__("gradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.Gradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.Gradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("type", arg, type) + self._set_property("typesrc", arg, typesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_line.py new file mode 100644 index 0000000..a3a941e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker" + _path_str = "scatterpolar.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatterpolar.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..6933852 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker.colorbar" + _path_str = "scatterpolar.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..730bf53 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker.colorbar" + _path_str = "scatterpolar.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py new file mode 100644 index 0000000..84d0132 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker.colorbar" + _path_str = "scatterpolar.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterpolar.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py new file mode 100644 index 0000000..3768be6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.marker.colorbar.title" + _path_str = "scatterpolar.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.m + arker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_marker.py new file mode 100644 index 0000000..ae28c0b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.selected" + _path_str = "scatterpolar.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolar.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_textfont.py new file mode 100644 index 0000000..c1cad86 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.selected" + _path_str = "scatterpolar.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.s + elected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_marker.py new file mode 100644 index 0000000..aa06db1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.unselected" + _path_str = "scatterpolar.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.u + nselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_textfont.py new file mode 100644 index 0000000..bd19b9b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolar/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolar.unselected" + _path_str = "scatterpolar.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolar.u + nselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolar.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolar.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/__init__.py new file mode 100644 index 0000000..55ee707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_hoverlabel.py new file mode 100644 index 0000000..9d33d8e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_legendgrouptitle.py new file mode 100644 index 0000000..6ff24db --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_line.py new file mode 100644 index 0000000..8fee4fa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_line.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the style of the lines. + + The 'dash' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['dash', 'dashdot', 'dot', 'longdash', 'longdashdot', + 'solid'] + + Returns + ------- + Any + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the style of the lines. + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Line` + color + Sets the line color. + dash + Sets the style of the lines. + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_marker.py new file mode 100644 index 0000000..616c489 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_marker.py @@ -0,0 +1,978 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.marker" + _valid_props = { + "angle", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "line", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatterpolargl.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatterpolargl.marker.Colo + rBar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.scatterpolargl.marker.Line + ` instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Marker` + angle + Sets the marker angle in respect to `angleref`. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatterpolargl.marker.Colo + rBar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.scatterpolargl.marker.Line + ` instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_selected.py new file mode 100644 index 0000000..b5e95a3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatterpolargl.selected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolargl.selected.Te + xtfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Selected` + marker + :class:`plotly.graph_objects.scatterpolargl.selected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolargl.selected.Te + xtfont` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_stream.py new file mode 100644 index 0000000..8b01198 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_textfont.py new file mode 100644 index 0000000..93fd42e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_textfont.py @@ -0,0 +1,399 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "size", + "sizesrc", + "style", + "stylesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'bold'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_unselected.py new file mode 100644 index 0000000..319c3b7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl" + _path_str = "scatterpolargl.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatterpolargl.unselected. + Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolargl.unselected. + Textfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.Unselected` + marker + :class:`plotly.graph_objects.scatterpolargl.unselected. + Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterpolargl.unselected. + Textfont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py new file mode 100644 index 0000000..d55cff8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.hoverlabel" + _path_str = "scatterpolargl.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/_font.py new file mode 100644 index 0000000..2f256fe --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.legendgrouptitle" + _path_str = "scatterpolargl.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/__init__.py new file mode 100644 index 0000000..e0fbf0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_colorbar.py new file mode 100644 index 0000000..ac11006 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.marker" + _path_str = "scatterpolargl.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatterpolargl + .marker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + scatterpolargl.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatterpolargl. + marker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolargl.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolargl.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatterpolargl.marker.colo + rbar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatterpolargl. + marker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rpolargl.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterpolargl.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatterpolargl.marker.colo + rbar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_line.py new file mode 100644 index 0000000..9f480f9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.marker" + _path_str = "scatterpolargl.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatterpolargl.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterpolargl.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..713228d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.marker.colorbar" + _path_str = "scatterpolargl.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..d30c15b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.marker.colorbar" + _path_str = "scatterpolargl.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py new file mode 100644 index 0000000..808e58b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.marker.colorbar" + _path_str = "scatterpolargl.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py new file mode 100644 index 0000000..555ee29 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.marker.colorbar.title" + _path_str = "scatterpolargl.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .marker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_marker.py new file mode 100644 index 0000000..9403086 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.selected" + _path_str = "scatterpolargl.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_textfont.py new file mode 100644 index 0000000..e62601f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.selected" + _path_str = "scatterpolargl.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_marker.py new file mode 100644 index 0000000..993de30 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.unselected" + _path_str = "scatterpolargl.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_textfont.py new file mode 100644 index 0000000..ce3650d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterpolargl/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterpolargl.unselected" + _path_str = "scatterpolargl.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterpolargl + .unselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterpolargl.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterpolargl.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/__init__.py new file mode 100644 index 0000000..55ee707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_hoverlabel.py new file mode 100644 index 0000000..6d7ab19 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattersmith.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_legendgrouptitle.py new file mode 100644 index 0000000..9dbdd04 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattersmith.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.L + egendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_line.py new file mode 100644 index 0000000..4c7aa71 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_line.py @@ -0,0 +1,277 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.line" + _valid_props = { + "backoff", + "backoffsrc", + "color", + "dash", + "shape", + "smoothing", + "width", + } + + @property + def backoff(self): + """ + Sets the line back off from the end point of the nth line + segment (in px). This option is useful e.g. to avoid overlap + with arrowhead markers. With "auto" the lines would trim before + markers if `marker.angleref` is set to "previous". + + The 'backoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["backoff"] + + @backoff.setter + def backoff(self, val): + self["backoff"] = val + + @property + def backoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `backoff`. + + The 'backoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["backoffsrc"] + + @backoffsrc.setter + def backoffsrc(self, val): + self["backoffsrc"] = val + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def shape(self): + """ + Determines the line shape. With "spline" the lines are drawn + using spline interpolation. The other available values + correspond to step-wise line shapes. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'spline'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def smoothing(self): + """ + Has an effect only if `shape` is set to "spline" Sets the + amount of smoothing. 0 corresponds to no smoothing (equivalent + to a "linear" shape). + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + backoff=None, + backoffsrc=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Line` + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("backoff", arg, backoff) + self._set_property("backoffsrc", arg, backoffsrc) + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("shape", arg, shape) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_marker.py new file mode 100644 index 0000000..4b5dfcf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_marker.py @@ -0,0 +1,1130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.marker" + _valid_props = { + "angle", + "angleref", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "gradient", + "line", + "maxdisplayed", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "standoff", + "standoffsrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def angleref(self): + """ + Sets the reference for marker angle. With "previous", angle 0 + points along the line from the previous point to this one. With + "up", angle 0 points toward the top of the screen. + + The 'angleref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['previous', 'up'] + + Returns + ------- + Any + """ + return self["angleref"] + + @angleref.setter + def angleref(self, val): + self["angleref"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattersmith.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.Gradient` + - A dict of string/value properties that will be passed + to the Gradient constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.Gradient + """ + return self["gradient"] + + @gradient.setter + def gradient(self, val): + self["gradient"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxdisplayed(self): + """ + Sets a maximum number of points to be drawn on the graph. 0 + corresponds to no limit. + + The 'maxdisplayed' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["maxdisplayed"] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self["maxdisplayed"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def standoff(self): + """ + Moves the marker away from the data point in the direction of + `angle` (in px). This can be useful for example if you have + another marker at this location and you want to point an + arrowhead marker at it. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def standoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `standoff`. + + The 'standoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["standoffsrc"] + + @standoffsrc.setter + def standoffsrc(self, val): + self["standoffsrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattersmith.marker.ColorB + ar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scattersmith.marker.Gradie + nt` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scattersmith.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + angleref=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + standoff=None, + standoffsrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Marker` + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scattersmith.marker.ColorB + ar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scattersmith.marker.Gradie + nt` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scattersmith.marker.Line` + instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("angleref", arg, angleref) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("gradient", arg, gradient) + self._set_property("line", arg, line) + self._set_property("maxdisplayed", arg, maxdisplayed) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("standoff", arg, standoff) + self._set_property("standoffsrc", arg, standoffsrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_selected.py new file mode 100644 index 0000000..a4c23ba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattersmith.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattersmith.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattersmith.selected.Mark + er` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattersmith.selected.Text + font` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Selected` + marker + :class:`plotly.graph_objects.scattersmith.selected.Mark + er` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattersmith.selected.Text + font` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_stream.py new file mode 100644 index 0000000..184e762 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_textfont.py new file mode 100644 index 0000000..cbc481a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_unselected.py new file mode 100644 index 0000000..8886fdb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith" + _path_str = "scattersmith.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scattersmith.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scattersmith.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scattersmith.unselected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattersmith.unselected.Te + xtfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.Unselected` + marker + :class:`plotly.graph_objects.scattersmith.unselected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scattersmith.unselected.Te + xtfont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/_font.py new file mode 100644 index 0000000..a342e77 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.hoverlabel" + _path_str = "scattersmith.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/_font.py new file mode 100644 index 0000000..1341c3b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.legendgrouptitle" + _path_str = "scattersmith.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.l + egendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/__init__.py new file mode 100644 index 0000000..6cfc468 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._gradient import Gradient + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._gradient.Gradient", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_colorbar.py new file mode 100644 index 0000000..c99af1e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker" + _path_str = "scattersmith.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scattersmith.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scattersmith.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scattersmith.m + arker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + scattersmith.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattersmith.ma + rker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rsmith.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattersmith.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattersmith.marker.colorb + ar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scattersmith.ma + rker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rsmith.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scattersmith.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scattersmith.marker.colorb + ar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_gradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_gradient.py new file mode 100644 index 0000000..32e158b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_gradient.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker" + _path_str = "scattersmith.marker.gradient" + _valid_props = {"color", "colorsrc", "type", "typesrc"} + + @property + def color(self): + """ + Sets the final color of the gradient fill: the center color for + radial, the right for horizontal, or the bottom for vertical. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def type(self): + """ + Sets the type of gradient used to fill the markers + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def typesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `type`. + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["typesrc"] + + @typesrc.setter + def typesrc(self, val): + self["typesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, type=None, typesrc=None, **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.marker.Gradient` + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + + Returns + ------- + Gradient + """ + super().__init__("gradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.Gradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.Gradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("type", arg, type) + self._set_property("typesrc", arg, typesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_line.py new file mode 100644 index 0000000..e12c8fc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker" + _path_str = "scattersmith.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scattersmith.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..47e244a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker.colorbar" + _path_str = "scattersmith.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.m + arker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..6fcd9e5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker.colorbar" + _path_str = "scattersmith.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.m + arker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_title.py new file mode 100644 index 0000000..61f1a36 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker.colorbar" + _path_str = "scattersmith.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scattersmith.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.m + arker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/_font.py new file mode 100644 index 0000000..2853b19 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.marker.colorbar.title" + _path_str = "scattersmith.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.m + arker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_marker.py new file mode 100644 index 0000000..7c441e4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.selected" + _path_str = "scattersmith.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scattersmith.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_textfont.py new file mode 100644 index 0000000..8958154 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.selected" + _path_str = "scattersmith.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.s + elected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_marker.py new file mode 100644 index 0000000..dbacc8f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.unselected" + _path_str = "scattersmith.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.u + nselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_textfont.py new file mode 100644 index 0000000..1118734 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scattersmith/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scattersmith.unselected" + _path_str = "scattersmith.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scattersmith.u + nselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scattersmith.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scattersmith.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/__init__.py new file mode 100644 index 0000000..55ee707 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/__init__.py @@ -0,0 +1,34 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._textfont import Textfont + from ._unselected import Unselected + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".selected", ".unselected"], + [ + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._textfont.Textfont", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_hoverlabel.py new file mode 100644 index 0000000..6f49de4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterternary.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_legendgrouptitle.py new file mode 100644 index 0000000..6d8fe3b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterternary.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_line.py new file mode 100644 index 0000000..015e097 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_line.py @@ -0,0 +1,277 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.line" + _valid_props = { + "backoff", + "backoffsrc", + "color", + "dash", + "shape", + "smoothing", + "width", + } + + @property + def backoff(self): + """ + Sets the line back off from the end point of the nth line + segment (in px). This option is useful e.g. to avoid overlap + with arrowhead markers. With "auto" the lines would trim before + markers if `marker.angleref` is set to "previous". + + The 'backoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["backoff"] + + @backoff.setter + def backoff(self, val): + self["backoff"] = val + + @property + def backoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `backoff`. + + The 'backoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["backoffsrc"] + + @backoffsrc.setter + def backoffsrc(self, val): + self["backoffsrc"] = val + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def shape(self): + """ + Determines the line shape. With "spline" the lines are drawn + using spline interpolation. The other available values + correspond to step-wise line shapes. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'spline'] + + Returns + ------- + Any + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def smoothing(self): + """ + Has an effect only if `shape` is set to "spline" Sets the + amount of smoothing. 0 corresponds to no smoothing (equivalent + to a "linear" shape). + + The 'smoothing' property is a number and may be specified as: + - An int or float in the interval [0, 1.3] + + Returns + ------- + int|float + """ + return self["smoothing"] + + @smoothing.setter + def smoothing(self, val): + self["smoothing"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + """ + + def __init__( + self, + arg=None, + backoff=None, + backoffsrc=None, + color=None, + dash=None, + shape=None, + smoothing=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Line` + backoff + Sets the line back off from the end point of the nth + line segment (in px). This option is useful e.g. to + avoid overlap with arrowhead markers. With "auto" the + lines would trim before markers if `marker.angleref` is + set to "previous". + backoffsrc + Sets the source reference on Chart Studio Cloud for + `backoff`. + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + shape + Determines the line shape. With "spline" the lines are + drawn using spline interpolation. The other available + values correspond to step-wise line shapes. + smoothing + Has an effect only if `shape` is set to "spline" Sets + the amount of smoothing. 0 corresponds to no smoothing + (equivalent to a "linear" shape). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("backoff", arg, backoff) + self._set_property("backoffsrc", arg, backoffsrc) + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("shape", arg, shape) + self._set_property("smoothing", arg, smoothing) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_marker.py new file mode 100644 index 0000000..defc23e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_marker.py @@ -0,0 +1,1130 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.marker" + _valid_props = { + "angle", + "angleref", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "gradient", + "line", + "maxdisplayed", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "standoff", + "standoffsrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def angleref(self): + """ + Sets the reference for marker angle. With "previous", angle 0 + points along the line from the previous point to this one. With + "up", angle 0 points toward the top of the screen. + + The 'angleref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['previous', 'up'] + + Returns + ------- + Any + """ + return self["angleref"] + + @angleref.setter + def angleref(self, val): + self["angleref"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatterternary.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def gradient(self): + """ + The 'gradient' property is an instance of Gradient + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.Gradient` + - A dict of string/value properties that will be passed + to the Gradient constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.Gradient + """ + return self["gradient"] + + @gradient.setter + def gradient(self, val): + self["gradient"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def maxdisplayed(self): + """ + Sets a maximum number of points to be drawn on the graph. 0 + corresponds to no limit. + + The 'maxdisplayed' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["maxdisplayed"] + + @maxdisplayed.setter + def maxdisplayed(self, val): + self["maxdisplayed"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def standoff(self): + """ + Moves the marker away from the data point in the direction of + `angle` (in px). This can be useful for example if you have + another marker at this location and you want to point an + arrowhead marker at it. + + The 'standoff' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["standoff"] + + @standoff.setter + def standoff(self, val): + self["standoff"] = val + + @property + def standoffsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `standoff`. + + The 'standoffsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["standoffsrc"] + + @standoffsrc.setter + def standoffsrc(self, val): + self["standoffsrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatterternary.marker.Colo + rBar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scatterternary.marker.Grad + ient` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scatterternary.marker.Line + ` instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + angleref=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + gradient=None, + line=None, + maxdisplayed=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + standoff=None, + standoffsrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Marker` + angle + Sets the marker angle in respect to `angleref`. + angleref + Sets the reference for marker angle. With "previous", + angle 0 points along the line from the previous point + to this one. With "up", angle 0 points toward the top + of the screen. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.scatterternary.marker.Colo + rBar` instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + gradient + :class:`plotly.graph_objects.scatterternary.marker.Grad + ient` instance or dict with compatible properties + line + :class:`plotly.graph_objects.scatterternary.marker.Line + ` instance or dict with compatible properties + maxdisplayed + Sets a maximum number of points to be drawn on the + graph. 0 corresponds to no limit. + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + standoff + Moves the marker away from the data point in the + direction of `angle` (in px). This can be useful for + example if you have another marker at this location and + you want to point an arrowhead marker at it. + standoffsrc + Sets the source reference on Chart Studio Cloud for + `standoff`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("angleref", arg, angleref) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("gradient", arg, gradient) + self._set_property("line", arg, line) + self._set_property("maxdisplayed", arg, maxdisplayed) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("standoff", arg, standoff) + self._set_property("standoffsrc", arg, standoffsrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_selected.py new file mode 100644 index 0000000..9259834 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_selected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.selected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterternary.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.selected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterternary.selected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatterternary.selected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterternary.selected.Te + xtfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Selected` + marker + :class:`plotly.graph_objects.scatterternary.selected.Ma + rker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterternary.selected.Te + xtfont` instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_stream.py new file mode 100644 index 0000000..54c0e1e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_textfont.py new file mode 100644 index 0000000..6a41c48 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the text font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_unselected.py new file mode 100644 index 0000000..f02bb39 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/_unselected.py @@ -0,0 +1,106 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary" + _path_str = "scatterternary.unselected" + _valid_props = {"marker", "textfont"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.scatterternary.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def textfont(self): + """ + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.unselected.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.scatterternary.unselected.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.scatterternary.unselected. + Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterternary.unselected. + Textfont` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, textfont=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.Unselected` + marker + :class:`plotly.graph_objects.scatterternary.unselected. + Marker` instance or dict with compatible properties + textfont + :class:`plotly.graph_objects.scatterternary.unselected. + Textfont` instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._set_property("textfont", arg, textfont) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/_font.py new file mode 100644 index 0000000..e642d4a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.hoverlabel" + _path_str = "scatterternary.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/_font.py new file mode 100644 index 0000000..a261155 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.legendgrouptitle" + _path_str = "scatterternary.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/__init__.py new file mode 100644 index 0000000..6cfc468 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._gradient import Gradient + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._gradient.Gradient", "._line.Line"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_colorbar.py new file mode 100644 index 0000000..141b719 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker" + _path_str = "scatterternary.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.scatterternary + .marker.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + scatterternary.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatterternary. + marker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rternary.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterternary.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatterternary.marker.colo + rbar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.scatterternary. + marker.colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.scatte + rternary.marker.colorbar.tickformatstopdefaults), sets + the default property values to use for elements of + scatterternary.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.scatterternary.marker.colo + rbar.Title` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_gradient.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_gradient.py new file mode 100644 index 0000000..fb803bc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_gradient.py @@ -0,0 +1,164 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Gradient(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker" + _path_str = "scatterternary.marker.gradient" + _valid_props = {"color", "colorsrc", "type", "typesrc"} + + @property + def color(self): + """ + Sets the final color of the gradient fill: the center color for + radial, the right for horizontal, or the bottom for vertical. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def type(self): + """ + Sets the type of gradient used to fill the markers + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['radial', 'horizontal', 'vertical', 'none'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def typesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `type`. + + The 'typesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["typesrc"] + + @typesrc.setter + def typesrc(self, val): + self["typesrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, type=None, typesrc=None, **kwargs + ): + """ + Construct a new Gradient object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .marker.Gradient` + color + Sets the final color of the gradient fill: the center + color for radial, the right for horizontal, or the + bottom for vertical. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + type + Sets the type of gradient used to fill the markers + typesrc + Sets the source reference on Chart Studio Cloud for + `type`. + + Returns + ------- + Gradient + """ + super().__init__("gradient") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.Gradient +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.Gradient`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("type", arg, type) + self._set_property("typesrc", arg, typesrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_line.py new file mode 100644 index 0000000..df4544e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker" + _path_str = "scatterternary.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to scatterternary.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.scatterternary.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..f35a4c5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker.colorbar" + _path_str = "scatterternary.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..266d0af --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker.colorbar" + _path_str = "scatterternary.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_title.py new file mode 100644 index 0000000..835128f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker.colorbar" + _path_str = "scatterternary.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.scatterternary.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py new file mode 100644 index 0000000..e6ea459 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.marker.colorbar.title" + _path_str = "scatterternary.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .marker.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_marker.py new file mode 100644 index 0000000..f82f165 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.selected" + _path_str = "scatterternary.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_textfont.py new file mode 100644 index 0000000..9e9ba65 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/selected/_textfont.py @@ -0,0 +1,81 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.selected" + _path_str = "scatterternary.selected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of selected points. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .selected.Textfont` + color + Sets the text font color of selected points. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.selected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.selected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/__init__.py new file mode 100644 index 0000000..8515490 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._marker.Marker", "._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_marker.py new file mode 100644 index 0000000..842223a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.unselected" + _path_str = "scatterternary.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_textfont.py new file mode 100644 index 0000000..06e08d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/scatterternary/unselected/_textfont.py @@ -0,0 +1,84 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "scatterternary.unselected" + _path_str = "scatterternary.unselected.textfont" + _valid_props = {"color"} + + @property + def color(self): + """ + Sets the text font color of unselected points, applied only + when a selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the text font color of unselected points, applied + only when a selection exists. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Textfont object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.scatterternary + .unselected.Textfont` + color + Sets the text font color of unselected points, applied + only when a selection exists. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.scatterternary.unselected.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.scatterternary.unselected.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/__init__.py new file mode 100644 index 0000000..200342c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/__init__.py @@ -0,0 +1,42 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._diagonal import Diagonal + from ._dimension import Dimension + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import dimension + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".dimension", + ".hoverlabel", + ".legendgrouptitle", + ".marker", + ".selected", + ".unselected", + ], + [ + "._diagonal.Diagonal", + "._dimension.Dimension", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_diagonal.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_diagonal.py new file mode 100644 index 0000000..a29d8e7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_diagonal.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Diagonal(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.diagonal" + _valid_props = {"visible"} + + @property + def visible(self): + """ + Determines whether or not subplots on the diagonal are + displayed. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + visible + Determines whether or not subplots on the diagonal are + displayed. + """ + + def __init__(self, arg=None, visible=None, **kwargs): + """ + Construct a new Diagonal object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.Diagonal` + visible + Determines whether or not subplots on the diagonal are + displayed. + + Returns + ------- + Diagonal + """ + super().__init__("diagonal") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Diagonal +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Diagonal`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_dimension.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_dimension.py new file mode 100644 index 0000000..beb275e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_dimension.py @@ -0,0 +1,293 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Dimension(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.dimension" + _valid_props = { + "axis", + "label", + "name", + "templateitemname", + "values", + "valuessrc", + "visible", + } + + @property + def axis(self): + """ + The 'axis' property is an instance of Axis + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.dimension.Axis` + - A dict of string/value properties that will be passed + to the Axis constructor + + Returns + ------- + plotly.graph_objs.splom.dimension.Axis + """ + return self["axis"] + + @axis.setter + def axis(self, val): + self["axis"] = val + + @property + def label(self): + """ + Sets the label corresponding to this splom dimension. + + The 'label' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["label"] + + @label.setter + def label(self, val): + self["label"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def values(self): + """ + Sets the dimension values to be plotted. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def visible(self): + """ + Determines whether or not this dimension is shown on the graph. + Note that even visible false dimension contribute to the + default grid generate by this splom trace. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + axis + :class:`plotly.graph_objects.splom.dimension.Axis` + instance or dict with compatible properties + label + Sets the label corresponding to this splom dimension. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the dimension values to be plotted. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + visible + Determines whether or not this dimension is shown on + the graph. Note that even visible false dimension + contribute to the default grid generate by this splom + trace. + """ + + def __init__( + self, + arg=None, + axis=None, + label=None, + name=None, + templateitemname=None, + values=None, + valuessrc=None, + visible=None, + **kwargs, + ): + """ + Construct a new Dimension object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.Dimension` + axis + :class:`plotly.graph_objects.splom.dimension.Axis` + instance or dict with compatible properties + label + Sets the label corresponding to this splom dimension. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + values + Sets the dimension values to be plotted. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + visible + Determines whether or not this dimension is shown on + the graph. Note that even visible false dimension + contribute to the default grid generate by this splom + trace. + + Returns + ------- + Dimension + """ + super().__init__("dimensions") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Dimension +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Dimension`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("axis", arg, axis) + self._set_property("label", arg, label) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_hoverlabel.py new file mode 100644 index 0000000..3412679 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.splom.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_legendgrouptitle.py new file mode 100644 index 0000000..e2def19 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.splom.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_marker.py new file mode 100644 index 0000000..5487958 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_marker.py @@ -0,0 +1,977 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.marker" + _valid_props = { + "angle", + "anglesrc", + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorbar", + "colorscale", + "colorsrc", + "line", + "opacity", + "opacitysrc", + "reversescale", + "showscale", + "size", + "sizemin", + "sizemode", + "sizeref", + "sizesrc", + "symbol", + "symbolsrc", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180, or a list, numpy array or other iterable thereof. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float|numpy.ndarray + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def anglesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `angle`. + + The 'anglesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["anglesrc"] + + @anglesrc.setter + def anglesrc(self, val): + self["anglesrc"] = val + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in `marker.color` is + set to a numerical array. In case `colorscale` is unspecified + or `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.color`) or the + bounds set in `marker.cmin` and `marker.cmax` Has an effect + only if in `marker.color` is set to a numerical array. Defaults + to `false` when `marker.cmin` and `marker.cmax` are set by the + user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color`. Has no + effect when `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.color` is set to a numerical array. Value should + have the same units as in `marker.color` and if set, + `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to splom.marker.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.splom.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in `marker.color` is + set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To + control the bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, `colorscale` + may be a palette name string of the following list: Blackbody,B + luered,Blues,Cividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic + ,Portland,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.splom.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def opacitysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `opacity`. + + The 'opacitysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["opacitysrc"] + + @opacitysrc.setter + def opacitysrc(self, val): + self["opacitysrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.color` is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the array + and `marker.cmax` will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if in `marker.color` is set to a + numerical array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizemin(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the minimum size (in px) of the rendered marker + points. + + The 'sizemin' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["sizemin"] + + @sizemin.setter + def sizemin(self, val): + self["sizemin"] = val + + @property + def sizemode(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the rule for which the data in `size` is converted + to pixels. + + The 'sizemode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['diameter', 'area'] + + Returns + ------- + Any + """ + return self["sizemode"] + + @sizemode.setter + def sizemode(self, val): + self["sizemode"] = val + + @property + def sizeref(self): + """ + Has an effect only if `marker.size` is set to a numerical + array. Sets the scale factor used to determine the rendered + size of marker points. Use with `sizemin` and `sizemode`. + + The 'sizeref' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["sizeref"] + + @sizeref.setter + def sizeref(self, val): + self["sizeref"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def symbolsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `symbol`. + + The 'symbolsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["symbolsrc"] + + @symbolsrc.setter + def symbolsrc(self, val): + self["symbolsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.splom.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.splom.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + """ + + def __init__( + self, + arg=None, + angle=None, + anglesrc=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorbar=None, + colorscale=None, + colorsrc=None, + line=None, + opacity=None, + opacitysrc=None, + reversescale=None, + showscale=None, + size=None, + sizemin=None, + sizemode=None, + sizeref=None, + sizesrc=None, + symbol=None, + symbolsrc=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.splom.Marker` + angle + Sets the marker angle in respect to `angleref`. + anglesrc + Sets the source reference on Chart Studio Cloud for + `angle`. + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if in + `marker.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in `marker.color`) + or the bounds set in `marker.cmin` and `marker.cmax` + Has an effect only if in `marker.color` is set to a + numerical array. Defaults to `false` when `marker.cmin` + and `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if in `marker.color` is + set to a numerical array. Value should have the same + units as in `marker.color`. Has no effect when + `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.color` is set to a numerical array. + Value should have the same units as in `marker.color` + and if set, `marker.cmax` must be set as well. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.splom.marker.ColorBar` + instance or dict with compatible properties + colorscale + Sets the colorscale. Has an effect only if in + `marker.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + line + :class:`plotly.graph_objects.splom.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + opacitysrc + Sets the source reference on Chart Studio Cloud for + `opacity`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.color` is set to a numerical array. If + true, `marker.cmin` will correspond to the last color + in the array and `marker.cmax` will correspond to the + first color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if in `marker.color` is + set to a numerical array. + size + Sets the marker size (in px). + sizemin + Has an effect only if `marker.size` is set to a + numerical array. Sets the minimum size (in px) of the + rendered marker points. + sizemode + Has an effect only if `marker.size` is set to a + numerical array. Sets the rule for which the data in + `size` is converted to pixels. + sizeref + Has an effect only if `marker.size` is set to a + numerical array. Sets the scale factor used to + determine the rendered size of marker points. Use with + `sizemin` and `sizemode`. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + symbolsrc + Sets the source reference on Chart Studio Cloud for + `symbol`. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("anglesrc", arg, anglesrc) + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("opacitysrc", arg, opacitysrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._set_property("size", arg, size) + self._set_property("sizemin", arg, sizemin) + self._set_property("sizemode", arg, sizemode) + self._set_property("sizeref", arg, sizeref) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("symbol", arg, symbol) + self._set_property("symbolsrc", arg, symbolsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_selected.py new file mode 100644 index 0000000..964b3a6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.splom.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.splom.selected.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.Selected` + marker + :class:`plotly.graph_objects.splom.selected.Marker` + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_stream.py new file mode 100644 index 0000000..1697225 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.splom.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_unselected.py new file mode 100644 index 0000000..bcf6df6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "splom" + _path_str = "splom.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.splom.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.splom.unselected.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.Unselected` + marker + :class:`plotly.graph_objects.splom.unselected.Marker` + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/__init__.py new file mode 100644 index 0000000..939c73e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._axis import Axis +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._axis.Axis"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/_axis.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/_axis.py new file mode 100644 index 0000000..0366dfc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/dimension/_axis.py @@ -0,0 +1,115 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Axis(_BaseTraceHierarchyType): + _parent_path_str = "splom.dimension" + _path_str = "splom.dimension.axis" + _valid_props = {"matches", "type"} + + @property + def matches(self): + """ + Determines whether or not the x & y axes generated by this + dimension match. Equivalent to setting the `matches` axis + attribute in the layout with the correct axis id. + + The 'matches' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["matches"] + + @matches.setter + def matches(self, val): + self["matches"] = val + + @property + def type(self): + """ + Sets the axis type for this dimension's generated x and y axes. + Note that the axis `type` values set in layout take precedence + over this attribute. + + The 'type' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['linear', 'log', 'date', 'category'] + + Returns + ------- + Any + """ + return self["type"] + + @type.setter + def type(self, val): + self["type"] = val + + @property + def _prop_descriptions(self): + return """\ + matches + Determines whether or not the x & y axes generated by + this dimension match. Equivalent to setting the + `matches` axis attribute in the layout with the correct + axis id. + type + Sets the axis type for this dimension's generated x and + y axes. Note that the axis `type` values set in layout + take precedence over this attribute. + """ + + def __init__(self, arg=None, matches=None, type=None, **kwargs): + """ + Construct a new Axis object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.dimension.Axis` + matches + Determines whether or not the x & y axes generated by + this dimension match. Equivalent to setting the + `matches` axis attribute in the layout with the correct + axis id. + type + Sets the axis type for this dimension's generated x and + y axes. Note that the axis `type` values set in layout + take precedence over this attribute. + + Returns + ------- + Axis + """ + super().__init__("axis") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.dimension.Axis +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.dimension.Axis`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("matches", arg, matches) + self._set_property("type", arg, type) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/_font.py new file mode 100644 index 0000000..64f7bec --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "splom.hoverlabel" + _path_str = "splom.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/_font.py new file mode 100644 index 0000000..c1fa90d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "splom.legendgrouptitle" + _path_str = "splom.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/__init__.py new file mode 100644 index 0000000..e0fbf0e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".colorbar"], ["._colorbar.ColorBar", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_colorbar.py new file mode 100644 index 0000000..60af07e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "splom.marker" + _path_str = "splom.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.splom.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.splom.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.splom.marker.c + olorbar.tickformatstopdefaults), sets the default property + values to use for elements of + splom.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.splom.marker.co + lorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.splom. + marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + splom.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.splom.marker.colorbar.Titl + e` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.splom.marker.co + lorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.splom. + marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + splom.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.splom.marker.colorbar.Titl + e` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_line.py new file mode 100644 index 0000000..764a952 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/_line.py @@ -0,0 +1,546 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "splom.marker" + _path_str = "splom.marker.line" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "color", + "coloraxis", + "colorscale", + "colorsrc", + "reversescale", + "width", + "widthsrc", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In case + `colorscale` is unspecified or `autocolorscale` is true, the + default palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here in `marker.line.color`) or the + bounds set in `marker.line.cmin` and `marker.line.cmax` Has an + effect only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be equidistant + to this point. Has an effect only if in `marker.line.color` is + set to a numerical array. Value should have the same units as + in `marker.line.color`. Has no effect when `marker.line.cauto` + is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + in `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color` and if + set, `marker.line.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A number that will be interpreted as a color + according to splom.marker.line.colorscale + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, + 'rgb(255,0,0)']]`. To control the bounds of the colorscale in + color space, use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,Electric, + Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,RdBu,Reds,Viridis, + YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if in + `marker.line.color` is set to a numerical array. If true, + `marker.line.cmin` will correspond to the last color in the + array and `marker.line.cmax` will correspond to the first + color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + color=None, + coloraxis=None, + colorscale=None, + colorsrc=None, + reversescale=None, + width=None, + widthsrc=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.marker.Line` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.line.colorscale`. Has an effect only if in + `marker.line.color` is set to a numerical array. In + case `colorscale` is unspecified or `autocolorscale` is + true, the default palette will be chosen according to + whether numbers in the `color` array are all positive, + all negative or mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here in + `marker.line.color`) or the bounds set in + `marker.line.cmin` and `marker.line.cmax` Has an effect + only if in `marker.line.color` is set to a numerical + array. Defaults to `false` when `marker.line.cmin` and + `marker.line.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmin` must + be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.line.cmin` and/or `marker.line.cmax` to be + equidistant to this point. Has an effect only if in + `marker.line.color` is set to a numerical array. Value + should have the same units as in `marker.line.color`. + Has no effect when `marker.line.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if in `marker.line.color` is set to a numerical + array. Value should have the same units as in + `marker.line.color` and if set, `marker.line.cmax` must + be set as well. + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorscale + Sets the colorscale. Has an effect only if in + `marker.line.color` is set to a numerical array. 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, `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. + To control the bounds of the colorscale in color space, + use `marker.line.cmin` and `marker.line.cmax`. + Alternatively, `colorscale` may be a palette name + string of the following list: Blackbody,Bluered,Blues,C + ividis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portl + and,Rainbow,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + reversescale + Reverses the color mapping if true. Has an effect only + if in `marker.line.color` is set to a numerical array. + If true, `marker.line.cmin` will correspond to the last + color in the array and `marker.line.cmax` will + correspond to the first color. + width + Sets the width (in px) of the lines bounding the marker + points. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("color", arg, color) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("reversescale", arg, reversescale) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..955183f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "splom.marker.colorbar" + _path_str = "splom.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.splom.marker.c + olorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..10c4054 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "splom.marker.colorbar" + _path_str = "splom.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.splom.marker.c + olorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_title.py new file mode 100644 index 0000000..4f40789 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "splom.marker.colorbar" + _path_str = "splom.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.splom.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.splom.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.marker.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/_font.py new file mode 100644 index 0000000..4bfb809 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "splom.marker.colorbar.title" + _path_str = "splom.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.splom.marker.c + olorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/_marker.py new file mode 100644 index 0000000..2002deb --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "splom.selected" + _path_str = "splom.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/_marker.py new file mode 100644 index 0000000..48f8c53 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/splom/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "splom.unselected" + _path_str = "splom.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.splom.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.splom.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.splom.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/__init__.py new file mode 100644 index 0000000..d141858 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/__init__.py @@ -0,0 +1,30 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._lighting import Lighting + from ._lightposition import Lightposition + from ._starts import Starts + from ._stream import Stream + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._lighting.Lighting", + "._lightposition.Lightposition", + "._starts.Starts", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_colorbar.py new file mode 100644 index 0000000..f4ce2df --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_colorbar.py @@ -0,0 +1,1721 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.streamtube.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.streamtube.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.streamtube.col + orbar.tickformatstopdefaults), sets the default property values + to use for elements of streamtube.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.streamtube.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.stream + tube.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + streamtube.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.streamtube.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.streamtube.colo + rbar.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.stream + tube.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + streamtube.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.streamtube.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_hoverlabel.py new file mode 100644 index 0000000..d197560 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.streamtube.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_legendgrouptitle.py new file mode 100644 index 0000000..0cb3297 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.streamtube.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lighting.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lighting.py new file mode 100644 index 0000000..0e1dd46 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lighting.py @@ -0,0 +1,260 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.lighting" + _valid_props = { + "ambient", + "diffuse", + "facenormalsepsilon", + "fresnel", + "roughness", + "specular", + "vertexnormalsepsilon", + } + + @property + def ambient(self): + """ + Ambient light increases overall color visibility but can wash + out the image. + + The 'ambient' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ambient"] + + @ambient.setter + def ambient(self, val): + self["ambient"] = val + + @property + def diffuse(self): + """ + Represents the extent that incident rays are reflected in a + range of angles. + + The 'diffuse' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["diffuse"] + + @diffuse.setter + def diffuse(self, val): + self["diffuse"] = val + + @property + def facenormalsepsilon(self): + """ + Epsilon for face normals calculation avoids math issues arising + from degenerate geometry. + + The 'facenormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["facenormalsepsilon"] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self["facenormalsepsilon"] = val + + @property + def fresnel(self): + """ + Represents the reflectance as a dependency of the viewing + angle; e.g. paper is reflective when viewing it from the edge + of the paper (almost 90 degrees), causing shine. + + The 'fresnel' property is a number and may be specified as: + - An int or float in the interval [0, 5] + + Returns + ------- + int|float + """ + return self["fresnel"] + + @fresnel.setter + def fresnel(self, val): + self["fresnel"] = val + + @property + def roughness(self): + """ + Alters specular reflection; the rougher the surface, the wider + and less contrasty the shine. + + The 'roughness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["roughness"] + + @roughness.setter + def roughness(self, val): + self["roughness"] = val + + @property + def specular(self): + """ + Represents the level that incident rays are reflected in a + single direction, causing shine. + + The 'specular' property is a number and may be specified as: + - An int or float in the interval [0, 2] + + Returns + ------- + int|float + """ + return self["specular"] + + @specular.setter + def specular(self, val): + self["specular"] = val + + @property + def vertexnormalsepsilon(self): + """ + Epsilon for vertex normals calculation avoids math issues + arising from degenerate geometry. + + The 'vertexnormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["vertexnormalsepsilon"] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self["vertexnormalsepsilon"] = val + + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs, + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.Lighting` + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super().__init__("lighting") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.Lighting +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.Lighting`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("ambient", arg, ambient) + self._set_property("diffuse", arg, diffuse) + self._set_property("facenormalsepsilon", arg, facenormalsepsilon) + self._set_property("fresnel", arg, fresnel) + self._set_property("roughness", arg, roughness) + self._set_property("specular", arg, specular) + self._set_property("vertexnormalsepsilon", arg, vertexnormalsepsilon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lightposition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lightposition.py new file mode 100644 index 0000000..0c6c7f7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_lightposition.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.lightposition" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Numeric vector, representing the X coordinate for each vertex. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Numeric vector, representing the Y coordinate for each vertex. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Numeric vector, representing the Z coordinate for each vertex. + + The 'z' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.Lightposition` + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super().__init__("lightposition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.Lightposition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.Lightposition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_starts.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_starts.py new file mode 100644 index 0000000..eccda64 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_starts.py @@ -0,0 +1,217 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Starts(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.starts" + _valid_props = {"x", "xsrc", "y", "ysrc", "z", "zsrc"} + + @property + def x(self): + """ + Sets the x components of the starting position of the + streamtubes + + The 'x' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `x`. + + The 'xsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["xsrc"] + + @xsrc.setter + def xsrc(self, val): + self["xsrc"] = val + + @property + def y(self): + """ + Sets the y components of the starting position of the + streamtubes + + The 'y' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def ysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `y`. + + The 'ysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ysrc"] + + @ysrc.setter + def ysrc(self, val): + self["ysrc"] = val + + @property + def z(self): + """ + Sets the z components of the starting position of the + streamtubes + + The 'z' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def zsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `z`. + + The 'zsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["zsrc"] + + @zsrc.setter + def zsrc(self, val): + self["zsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Sets the x components of the starting position of the + streamtubes + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y components of the starting position of the + streamtubes + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z components of the starting position of the + streamtubes + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + """ + + def __init__( + self, + arg=None, + x=None, + xsrc=None, + y=None, + ysrc=None, + z=None, + zsrc=None, + **kwargs, + ): + """ + Construct a new Starts object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.Starts` + x + Sets the x components of the starting position of the + streamtubes + xsrc + Sets the source reference on Chart Studio Cloud for + `x`. + y + Sets the y components of the starting position of the + streamtubes + ysrc + Sets the source reference on Chart Studio Cloud for + `y`. + z + Sets the z components of the starting position of the + streamtubes + zsrc + Sets the source reference on Chart Studio Cloud for + `z`. + + Returns + ------- + Starts + """ + super().__init__("starts") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.Starts +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.Starts`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("xsrc", arg, xsrc) + self._set_property("y", arg, y) + self._set_property("ysrc", arg, ysrc) + self._set_property("z", arg, z) + self._set_property("zsrc", arg, zsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_stream.py new file mode 100644 index 0000000..46d9371 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "streamtube" + _path_str = "streamtube.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickfont.py new file mode 100644 index 0000000..b9ae28e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "streamtube.colorbar" + _path_str = "streamtube.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py new file mode 100644 index 0000000..3bb5efa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "streamtube.colorbar" + _path_str = "streamtube.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.streamtube.col + orbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_title.py new file mode 100644 index 0000000..e9b903a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "streamtube.colorbar" + _path_str = "streamtube.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.streamtube.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.streamtube.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/_font.py new file mode 100644 index 0000000..a1869a5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "streamtube.colorbar.title" + _path_str = "streamtube.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.streamtube.col + orbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/_font.py new file mode 100644 index 0000000..d8d34b5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "streamtube.hoverlabel" + _path_str = "streamtube.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.streamtube.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/_font.py new file mode 100644 index 0000000..3bf085d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/streamtube/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "streamtube.legendgrouptitle" + _path_str = "streamtube.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.streamtube.leg + endgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.streamtube.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.streamtube.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/__init__.py new file mode 100644 index 0000000..69c0dee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/__init__.py @@ -0,0 +1,36 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._leaf import Leaf + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._root import Root + from ._stream import Stream + from ._textfont import Textfont + from . import hoverlabel + from . import legendgrouptitle + from . import marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker"], + [ + "._domain.Domain", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._leaf.Leaf", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._root.Root", + "._stream.Stream", + "._textfont.Textfont", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_domain.py new file mode 100644 index 0000000..5e50ff1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this sunburst trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this sunburst trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this sunburst trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this sunburst trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this sunburst trace . + row + If there is a layout grid, use the domain for this row + in the grid for this sunburst trace . + x + Sets the horizontal domain of this sunburst trace (in + plot fraction). + y + Sets the vertical domain of this sunburst trace (in + plot fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this sunburst trace . + row + If there is a layout grid, use the domain for this row + in the grid for this sunburst trace . + x + Sets the horizontal domain of this sunburst trace (in + plot fraction). + y + Sets the vertical domain of this sunburst trace (in + plot fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_hoverlabel.py new file mode 100644 index 0000000..bcfd1f5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sunburst.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_insidetextfont.py new file mode 100644 index 0000000..48d3703 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `textinfo` lying inside the sector. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_leaf.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_leaf.py new file mode 100644 index 0000000..9b996c8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_leaf.py @@ -0,0 +1,79 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Leaf(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.leaf" + _valid_props = {"opacity"} + + @property + def opacity(self): + """ + Sets the opacity of the leaves. With colorscale it is defaulted + to 1; otherwise it is defaulted to 0.7 + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def _prop_descriptions(self): + return """\ + opacity + Sets the opacity of the leaves. With colorscale it is + defaulted to 1; otherwise it is defaulted to 0.7 + """ + + def __init__(self, arg=None, opacity=None, **kwargs): + """ + Construct a new Leaf object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.Leaf` + opacity + Sets the opacity of the leaves. With colorscale it is + defaulted to 1; otherwise it is defaulted to 0.7 + + Returns + ------- + Leaf + """ + super().__init__("leaf") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Leaf +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Leaf`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("opacity", arg, opacity) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_legendgrouptitle.py new file mode 100644 index 0000000..ccbc7fd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sunburst.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_marker.py new file mode 100644 index 0000000..4a4234e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_marker.py @@ -0,0 +1,579 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colors", + "colorscale", + "colorssrc", + "line", + "pattern", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is set to a + numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here colors) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect only if colors is + set to a numerical array. Defaults to `false` when + `marker.cmin` and `marker.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + colors is set to a numerical array. Value should have the same + units as colors and if set, `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if colors is set to a numerical array. Value should + have the same units as colors. Has no effect when + `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + colors is set to a numerical array. Value should have the same + units as colors and if set, `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colors(self): + """ + Sets the color of each sector of this trace. If not specified, + the default trace color set is used to pick the sector colors. + + The 'colors' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["colors"] + + @colors.setter + def colors(self, val): + self["colors"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if colors is set to a + numerical array. 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `marker.cmin` and + `marker.cmax`. Alternatively, `colorscale` may be a palette + name string of the following list: Blackbody,Bluered,Blues,Civi + dis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow + ,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `colors`. + + The 'colorssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorssrc"] + + @colorssrc.setter + def colorssrc(self, val): + self["colorssrc"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if + colors is set to a numerical array. If true, `marker.cmin` will + correspond to the last color in the array and `marker.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if colors is set to a numerical + array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is + set to a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the default + palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or + mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here colors) or the + bounds set in `marker.cmin` and `marker.cmax` Has an + effect only if colors is set to a numerical array. + Defaults to `false` when `marker.cmin` and + `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if colors is set to a + numerical array. Value should have the same units as + colors. Has no effect when `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.sunburst.marker.ColorBar` + instance or dict with compatible properties + colors + Sets the color of each sector of this trace. If not + specified, the default trace color set is used to pick + the sector colors. + colorscale + Sets the colorscale. Has an effect only if colors is + set to a numerical array. 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, `[[0, + 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.sunburst.marker.Line` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if colors is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the + array and `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if colors is set to a + numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colors=None, + colorscale=None, + colorssrc=None, + line=None, + pattern=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is + set to a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the default + palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or + mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here colors) or the + bounds set in `marker.cmin` and `marker.cmax` Has an + effect only if colors is set to a numerical array. + Defaults to `false` when `marker.cmin` and + `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if colors is set to a + numerical array. Value should have the same units as + colors. Has no effect when `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.sunburst.marker.ColorBar` + instance or dict with compatible properties + colors + Sets the color of each sector of this trace. If not + specified, the default trace color set is used to pick + the sector colors. + colorscale + Sets the colorscale. Has an effect only if colors is + set to a numerical array. 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, `[[0, + 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + line + :class:`plotly.graph_objects.sunburst.marker.Line` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if colors is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the + array and `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if colors is set to a + numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colors", arg, colors) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorssrc", arg, colorssrc) + self._set_property("line", arg, line) + self._set_property("pattern", arg, pattern) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_outsidetextfont.py new file mode 100644 index 0000000..07709e4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_outsidetextfont.py @@ -0,0 +1,591 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `textinfo` lying outside the sector. + This option refers to the root of the hierarchy presented at + the center of a sunburst graph. Please note that if a hierarchy + has multiple root nodes, this option won't have any effect and + `insidetextfont` would be used. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_root.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_root.py new file mode 100644 index 0000000..87854a8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_root.py @@ -0,0 +1,86 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Root(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.root" + _valid_props = {"color"} + + @property + def color(self): + """ + sets the color of the root node for a sunburst/treemap/icicle + trace. this has no effect when a colorscale is used to set the + markers. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + sets the color of the root node for a + sunburst/treemap/icicle trace. this has no effect when + a colorscale is used to set the markers. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Root object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.Root` + color + sets the color of the root node for a + sunburst/treemap/icicle trace. this has no effect when + a colorscale is used to set the markers. + + Returns + ------- + Root + """ + super().__init__("root") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Root +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Root`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_stream.py new file mode 100644 index 0000000..5680641 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_textfont.py new file mode 100644 index 0000000..6dcabc1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "sunburst" + _path_str = "sunburst.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `textinfo`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/_font.py new file mode 100644 index 0000000..33c7f2b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.hoverlabel" + _path_str = "sunburst.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/_font.py new file mode 100644 index 0000000..5b753a2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.legendgrouptitle" + _path_str = "sunburst.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.legen + dgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/__init__.py new file mode 100644 index 0000000..e2d7a12 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from ._pattern import Pattern + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._line.Line", "._pattern.Pattern"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_colorbar.py new file mode 100644 index 0000000..af16789 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker" + _path_str = "sunburst.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.sunburst.marke + r.colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + sunburst.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.sunburst.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.sunbur + st.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + sunburst.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.sunburst.marker.colorbar.T + itle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.sunburst.marker + .colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.sunbur + st.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + sunburst.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.sunburst.marker.colorbar.T + itle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_line.py new file mode 100644 index 0000000..a14be3b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_line.py @@ -0,0 +1,163 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker" + _path_str = "sunburst.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. Defaults to + the `paper_bgcolor` value. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.marker.Line` + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_pattern.py new file mode 100644 index 0000000..16346c9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker" + _path_str = "sunburst.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.sunburst.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..04da881 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker.colorbar" + _path_str = "sunburst.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..893cef9 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker.colorbar" + _path_str = "sunburst.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_title.py new file mode 100644 index 0000000..c824761 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker.colorbar" + _path_str = "sunburst.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.sunburst.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py new file mode 100644 index 0000000..ba4e0c7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/sunburst/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "sunburst.marker.colorbar.title" + _path_str = "sunburst.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.sunburst.marke + r.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.sunburst.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.sunburst.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/__init__.py new file mode 100644 index 0000000..f0a5e46 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/__init__.py @@ -0,0 +1,31 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._contours import Contours + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._lighting import Lighting + from ._lightposition import Lightposition + from ._stream import Stream + from . import colorbar + from . import contours + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar", ".contours", ".hoverlabel", ".legendgrouptitle"], + [ + "._colorbar.ColorBar", + "._contours.Contours", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._lighting.Lighting", + "._lightposition.Lightposition", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_colorbar.py new file mode 100644 index 0000000..83db758 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.surface.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.surface.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.surface.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.surface.colorbar.tickformatstopdefaults), + sets the default property values to use for elements of + surface.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.surface.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.surface.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.surface.colorba + r.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.surfac + e.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + surface.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.surface.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.surface.colorba + r.Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.surfac + e.colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + surface.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.surface.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_contours.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_contours.py new file mode 100644 index 0000000..9c42096 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_contours.py @@ -0,0 +1,132 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contours(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.contours" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.contours.X` + - A dict of string/value properties that will be passed + to the X constructor + + Returns + ------- + plotly.graph_objs.surface.contours.X + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.contours.Y` + - A dict of string/value properties that will be passed + to the Y constructor + + Returns + ------- + plotly.graph_objs.surface.contours.Y + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.contours.Z` + - A dict of string/value properties that will be passed + to the Z constructor + + Returns + ------- + plotly.graph_objs.surface.contours.Z + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + :class:`plotly.graph_objects.surface.contours.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.surface.contours.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.surface.contours.Z` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Contours object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.Contours` + x + :class:`plotly.graph_objects.surface.contours.X` + instance or dict with compatible properties + y + :class:`plotly.graph_objects.surface.contours.Y` + instance or dict with compatible properties + z + :class:`plotly.graph_objects.surface.contours.Z` + instance or dict with compatible properties + + Returns + ------- + Contours + """ + super().__init__("contours") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.Contours +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.Contours`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_hoverlabel.py new file mode 100644 index 0000000..fef0273 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.surface.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_legendgrouptitle.py new file mode 100644 index 0000000..d77d8a1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.surface.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lighting.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lighting.py new file mode 100644 index 0000000..b8499ee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lighting.py @@ -0,0 +1,198 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.lighting" + _valid_props = {"ambient", "diffuse", "fresnel", "roughness", "specular"} + + @property + def ambient(self): + """ + Ambient light increases overall color visibility but can wash + out the image. + + The 'ambient' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ambient"] + + @ambient.setter + def ambient(self, val): + self["ambient"] = val + + @property + def diffuse(self): + """ + Represents the extent that incident rays are reflected in a + range of angles. + + The 'diffuse' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["diffuse"] + + @diffuse.setter + def diffuse(self, val): + self["diffuse"] = val + + @property + def fresnel(self): + """ + Represents the reflectance as a dependency of the viewing + angle; e.g. paper is reflective when viewing it from the edge + of the paper (almost 90 degrees), causing shine. + + The 'fresnel' property is a number and may be specified as: + - An int or float in the interval [0, 5] + + Returns + ------- + int|float + """ + return self["fresnel"] + + @fresnel.setter + def fresnel(self, val): + self["fresnel"] = val + + @property + def roughness(self): + """ + Alters specular reflection; the rougher the surface, the wider + and less contrasty the shine. + + The 'roughness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["roughness"] + + @roughness.setter + def roughness(self, val): + self["roughness"] = val + + @property + def specular(self): + """ + Represents the level that incident rays are reflected in a + single direction, causing shine. + + The 'specular' property is a number and may be specified as: + - An int or float in the interval [0, 2] + + Returns + ------- + int|float + """ + return self["specular"] + + @specular.setter + def specular(self, val): + self["specular"] = val + + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + fresnel=None, + roughness=None, + specular=None, + **kwargs, + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.Lighting` + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + + Returns + ------- + Lighting + """ + super().__init__("lighting") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.Lighting +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.Lighting`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("ambient", arg, ambient) + self._set_property("diffuse", arg, diffuse) + self._set_property("fresnel", arg, fresnel) + self._set_property("roughness", arg, roughness) + self._set_property("specular", arg, specular) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lightposition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lightposition.py new file mode 100644 index 0000000..283529d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_lightposition.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.lightposition" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Numeric vector, representing the X coordinate for each vertex. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Numeric vector, representing the Y coordinate for each vertex. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Numeric vector, representing the Z coordinate for each vertex. + + The 'z' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.Lightposition` + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super().__init__("lightposition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.Lightposition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.Lightposition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_stream.py new file mode 100644 index 0000000..70b8602 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "surface" + _path_str = "surface.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickfont.py new file mode 100644 index 0000000..b8736fc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "surface.colorbar" + _path_str = "surface.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickformatstop.py new file mode 100644 index 0000000..893ffaf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "surface.colorbar" + _path_str = "surface.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.surface.colorb + ar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_title.py new file mode 100644 index 0000000..4728e34 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "surface.colorbar" + _path_str = "surface.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.surface.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/_font.py new file mode 100644 index 0000000..a5d1736 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "surface.colorbar.title" + _path_str = "surface.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/__init__.py new file mode 100644 index 0000000..12aff2a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._x import X + from ._y import Y + from ._z import Z + from . import x + from . import y + from . import z +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".x", ".y", ".z"], ["._x.X", "._y.Y", "._z.Z"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_x.py new file mode 100644 index 0000000..9df5130 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_x.py @@ -0,0 +1,362 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + _parent_path_str = "surface.contours" + _path_str = "surface.contours.x" + _valid_props = { + "color", + "end", + "highlight", + "highlightcolor", + "highlightwidth", + "project", + "show", + "size", + "start", + "usecolormap", + "width", + } + + @property + def color(self): + """ + Sets the color of the contour lines. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def end(self): + """ + Sets the end contour level value. Must be more than + `contours.start` + + The 'end' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def highlight(self): + """ + Determines whether or not contour lines about the x dimension + are highlighted on hover. + + The 'highlight' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["highlight"] + + @highlight.setter + def highlight(self, val): + self["highlight"] = val + + @property + def highlightcolor(self): + """ + Sets the color of the highlighted contour lines. + + The 'highlightcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["highlightcolor"] + + @highlightcolor.setter + def highlightcolor(self, val): + self["highlightcolor"] = val + + @property + def highlightwidth(self): + """ + Sets the width of the highlighted contour lines. + + The 'highlightwidth' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["highlightwidth"] + + @highlightwidth.setter + def highlightwidth(self, val): + self["highlightwidth"] = val + + @property + def project(self): + """ + The 'project' property is an instance of Project + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.contours.x.Project` + - A dict of string/value properties that will be passed + to the Project constructor + + Returns + ------- + plotly.graph_objs.surface.contours.x.Project + """ + return self["project"] + + @project.setter + def project(self, val): + self["project"] = val + + @property + def show(self): + """ + Determines whether or not contour lines about the x dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def size(self): + """ + Sets the step between each contour level. Must be positive. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting contour level value. Must be less than + `contours.end` + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def usecolormap(self): + """ + An alternate to "color". Determines whether or not the contour + lines are colored using the trace "colorscale". + + The 'usecolormap' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["usecolormap"] + + @usecolormap.setter + def usecolormap(self, val): + self["usecolormap"] = val + + @property + def width(self): + """ + Sets the width of the contour lines. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + end + Sets the end contour level value. Must be more than + `contours.start` + highlight + Determines whether or not contour lines about the x + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + :class:`plotly.graph_objects.surface.contours.x.Project + ` instance or dict with compatible properties + show + Determines whether or not contour lines about the x + dimension are drawn. + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + """ + + def __init__( + self, + arg=None, + color=None, + end=None, + highlight=None, + highlightcolor=None, + highlightwidth=None, + project=None, + show=None, + size=None, + start=None, + usecolormap=None, + width=None, + **kwargs, + ): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.contours.X` + color + Sets the color of the contour lines. + end + Sets the end contour level value. Must be more than + `contours.start` + highlight + Determines whether or not contour lines about the x + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + :class:`plotly.graph_objects.surface.contours.x.Project + ` instance or dict with compatible properties + show + Determines whether or not contour lines about the x + dimension are drawn. + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + X + """ + super().__init__("x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.contours.X +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.contours.X`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("end", arg, end) + self._set_property("highlight", arg, highlight) + self._set_property("highlightcolor", arg, highlightcolor) + self._set_property("highlightwidth", arg, highlightwidth) + self._set_property("project", arg, project) + self._set_property("show", arg, show) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._set_property("usecolormap", arg, usecolormap) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_y.py new file mode 100644 index 0000000..00c1042 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_y.py @@ -0,0 +1,362 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + _parent_path_str = "surface.contours" + _path_str = "surface.contours.y" + _valid_props = { + "color", + "end", + "highlight", + "highlightcolor", + "highlightwidth", + "project", + "show", + "size", + "start", + "usecolormap", + "width", + } + + @property + def color(self): + """ + Sets the color of the contour lines. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def end(self): + """ + Sets the end contour level value. Must be more than + `contours.start` + + The 'end' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def highlight(self): + """ + Determines whether or not contour lines about the y dimension + are highlighted on hover. + + The 'highlight' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["highlight"] + + @highlight.setter + def highlight(self, val): + self["highlight"] = val + + @property + def highlightcolor(self): + """ + Sets the color of the highlighted contour lines. + + The 'highlightcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["highlightcolor"] + + @highlightcolor.setter + def highlightcolor(self, val): + self["highlightcolor"] = val + + @property + def highlightwidth(self): + """ + Sets the width of the highlighted contour lines. + + The 'highlightwidth' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["highlightwidth"] + + @highlightwidth.setter + def highlightwidth(self, val): + self["highlightwidth"] = val + + @property + def project(self): + """ + The 'project' property is an instance of Project + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.contours.y.Project` + - A dict of string/value properties that will be passed + to the Project constructor + + Returns + ------- + plotly.graph_objs.surface.contours.y.Project + """ + return self["project"] + + @project.setter + def project(self, val): + self["project"] = val + + @property + def show(self): + """ + Determines whether or not contour lines about the y dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def size(self): + """ + Sets the step between each contour level. Must be positive. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting contour level value. Must be less than + `contours.end` + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def usecolormap(self): + """ + An alternate to "color". Determines whether or not the contour + lines are colored using the trace "colorscale". + + The 'usecolormap' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["usecolormap"] + + @usecolormap.setter + def usecolormap(self, val): + self["usecolormap"] = val + + @property + def width(self): + """ + Sets the width of the contour lines. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + end + Sets the end contour level value. Must be more than + `contours.start` + highlight + Determines whether or not contour lines about the y + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + :class:`plotly.graph_objects.surface.contours.y.Project + ` instance or dict with compatible properties + show + Determines whether or not contour lines about the y + dimension are drawn. + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + """ + + def __init__( + self, + arg=None, + color=None, + end=None, + highlight=None, + highlightcolor=None, + highlightwidth=None, + project=None, + show=None, + size=None, + start=None, + usecolormap=None, + width=None, + **kwargs, + ): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.contours.Y` + color + Sets the color of the contour lines. + end + Sets the end contour level value. Must be more than + `contours.start` + highlight + Determines whether or not contour lines about the y + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + :class:`plotly.graph_objects.surface.contours.y.Project + ` instance or dict with compatible properties + show + Determines whether or not contour lines about the y + dimension are drawn. + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + Y + """ + super().__init__("y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.contours.Y +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.contours.Y`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("end", arg, end) + self._set_property("highlight", arg, highlight) + self._set_property("highlightcolor", arg, highlightcolor) + self._set_property("highlightwidth", arg, highlightwidth) + self._set_property("project", arg, project) + self._set_property("show", arg, show) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._set_property("usecolormap", arg, usecolormap) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_z.py new file mode 100644 index 0000000..62d2416 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/_z.py @@ -0,0 +1,362 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + _parent_path_str = "surface.contours" + _path_str = "surface.contours.z" + _valid_props = { + "color", + "end", + "highlight", + "highlightcolor", + "highlightwidth", + "project", + "show", + "size", + "start", + "usecolormap", + "width", + } + + @property + def color(self): + """ + Sets the color of the contour lines. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def end(self): + """ + Sets the end contour level value. Must be more than + `contours.start` + + The 'end' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["end"] + + @end.setter + def end(self, val): + self["end"] = val + + @property + def highlight(self): + """ + Determines whether or not contour lines about the z dimension + are highlighted on hover. + + The 'highlight' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["highlight"] + + @highlight.setter + def highlight(self, val): + self["highlight"] = val + + @property + def highlightcolor(self): + """ + Sets the color of the highlighted contour lines. + + The 'highlightcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["highlightcolor"] + + @highlightcolor.setter + def highlightcolor(self, val): + self["highlightcolor"] = val + + @property + def highlightwidth(self): + """ + Sets the width of the highlighted contour lines. + + The 'highlightwidth' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["highlightwidth"] + + @highlightwidth.setter + def highlightwidth(self, val): + self["highlightwidth"] = val + + @property + def project(self): + """ + The 'project' property is an instance of Project + that may be specified as: + - An instance of :class:`plotly.graph_objs.surface.contours.z.Project` + - A dict of string/value properties that will be passed + to the Project constructor + + Returns + ------- + plotly.graph_objs.surface.contours.z.Project + """ + return self["project"] + + @project.setter + def project(self, val): + self["project"] = val + + @property + def show(self): + """ + Determines whether or not contour lines about the z dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def size(self): + """ + Sets the step between each contour level. Must be positive. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def start(self): + """ + Sets the starting contour level value. Must be less than + `contours.end` + + The 'start' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["start"] + + @start.setter + def start(self, val): + self["start"] = val + + @property + def usecolormap(self): + """ + An alternate to "color". Determines whether or not the contour + lines are colored using the trace "colorscale". + + The 'usecolormap' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["usecolormap"] + + @usecolormap.setter + def usecolormap(self, val): + self["usecolormap"] = val + + @property + def width(self): + """ + Sets the width of the contour lines. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + end + Sets the end contour level value. Must be more than + `contours.start` + highlight + Determines whether or not contour lines about the z + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + :class:`plotly.graph_objects.surface.contours.z.Project + ` instance or dict with compatible properties + show + Determines whether or not contour lines about the z + dimension are drawn. + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + """ + + def __init__( + self, + arg=None, + color=None, + end=None, + highlight=None, + highlightcolor=None, + highlightwidth=None, + project=None, + show=None, + size=None, + start=None, + usecolormap=None, + width=None, + **kwargs, + ): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.contours.Z` + color + Sets the color of the contour lines. + end + Sets the end contour level value. Must be more than + `contours.start` + highlight + Determines whether or not contour lines about the z + dimension are highlighted on hover. + highlightcolor + Sets the color of the highlighted contour lines. + highlightwidth + Sets the width of the highlighted contour lines. + project + :class:`plotly.graph_objects.surface.contours.z.Project + ` instance or dict with compatible properties + show + Determines whether or not contour lines about the z + dimension are drawn. + size + Sets the step between each contour level. Must be + positive. + start + Sets the starting contour level value. Must be less + than `contours.end` + usecolormap + An alternate to "color". Determines whether or not the + contour lines are colored using the trace "colorscale". + width + Sets the width of the contour lines. + + Returns + ------- + Z + """ + super().__init__("z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.contours.Z +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.contours.Z`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("end", arg, end) + self._set_property("highlight", arg, highlight) + self._set_property("highlightcolor", arg, highlightcolor) + self._set_property("highlightwidth", arg, highlightwidth) + self._set_property("project", arg, project) + self._set_property("show", arg, show) + self._set_property("size", arg, size) + self._set_property("start", arg, start) + self._set_property("usecolormap", arg, usecolormap) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/__init__.py new file mode 100644 index 0000000..bb18f1a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._project import Project +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._project.Project"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/_project.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/_project.py new file mode 100644 index 0000000..d2ac9d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/x/_project.py @@ -0,0 +1,156 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Project(_BaseTraceHierarchyType): + _parent_path_str = "surface.contours.x" + _path_str = "surface.contours.x.project" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Determines whether or not these contour lines are projected on + the x plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'x' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Determines whether or not these contour lines are projected on + the y plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'y' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Determines whether or not these contour lines are projected on + the z plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'z' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Determines whether or not these contour lines are + projected on the x plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + y + Determines whether or not these contour lines are + projected on the y plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + z + Determines whether or not these contour lines are + projected on the z plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Project object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.contours.x.Project` + x + Determines whether or not these contour lines are + projected on the x plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + y + Determines whether or not these contour lines are + projected on the y plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + z + Determines whether or not these contour lines are + projected on the z plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + + Returns + ------- + Project + """ + super().__init__("project") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.contours.x.Project +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.contours.x.Project`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/__init__.py new file mode 100644 index 0000000..bb18f1a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._project import Project +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._project.Project"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/_project.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/_project.py new file mode 100644 index 0000000..9a026aa --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/y/_project.py @@ -0,0 +1,156 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Project(_BaseTraceHierarchyType): + _parent_path_str = "surface.contours.y" + _path_str = "surface.contours.y.project" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Determines whether or not these contour lines are projected on + the x plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'x' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Determines whether or not these contour lines are projected on + the y plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'y' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Determines whether or not these contour lines are projected on + the z plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'z' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Determines whether or not these contour lines are + projected on the x plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + y + Determines whether or not these contour lines are + projected on the y plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + z + Determines whether or not these contour lines are + projected on the z plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Project object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.contours.y.Project` + x + Determines whether or not these contour lines are + projected on the x plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + y + Determines whether or not these contour lines are + projected on the y plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + z + Determines whether or not these contour lines are + projected on the z plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + + Returns + ------- + Project + """ + super().__init__("project") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.contours.y.Project +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.contours.y.Project`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/__init__.py new file mode 100644 index 0000000..bb18f1a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._project import Project +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._project.Project"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/_project.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/_project.py new file mode 100644 index 0000000..51ae7ef --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/contours/z/_project.py @@ -0,0 +1,156 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Project(_BaseTraceHierarchyType): + _parent_path_str = "surface.contours.z" + _path_str = "surface.contours.z.project" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Determines whether or not these contour lines are projected on + the x plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'x' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Determines whether or not these contour lines are projected on + the y plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'y' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Determines whether or not these contour lines are projected on + the z plane. If `highlight` is set to True (the default), the + projected lines are shown on hover. If `show` is set to True, + the projected lines are shown in permanence. + + The 'z' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Determines whether or not these contour lines are + projected on the x plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + y + Determines whether or not these contour lines are + projected on the y plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + z + Determines whether or not these contour lines are + projected on the z plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Project object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.contours.z.Project` + x + Determines whether or not these contour lines are + projected on the x plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + y + Determines whether or not these contour lines are + projected on the y plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + z + Determines whether or not these contour lines are + projected on the z plane. If `highlight` is set to True + (the default), the projected lines are shown on hover. + If `show` is set to True, the projected lines are shown + in permanence. + + Returns + ------- + Project + """ + super().__init__("project") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.contours.z.Project +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.contours.z.Project`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/_font.py new file mode 100644 index 0000000..32d05ea --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "surface.hoverlabel" + _path_str = "surface.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.surface.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/_font.py new file mode 100644 index 0000000..37ecb29 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/surface/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "surface.legendgrouptitle" + _path_str = "surface.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.surface.legend + grouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.surface.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.surface.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/__init__.py new file mode 100644 index 0000000..4442a1a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/__init__.py @@ -0,0 +1,29 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._cells import Cells + from ._domain import Domain + from ._header import Header + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._stream import Stream + from . import cells + from . import header + from . import hoverlabel + from . import legendgrouptitle +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".cells", ".header", ".hoverlabel", ".legendgrouptitle"], + [ + "._cells.Cells", + "._domain.Domain", + "._header.Header", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._stream.Stream", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_cells.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_cells.py new file mode 100644 index 0000000..083afdd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_cells.py @@ -0,0 +1,464 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Cells(_BaseTraceHierarchyType): + _parent_path_str = "table" + _path_str = "table.cells" + _valid_props = { + "align", + "alignsrc", + "fill", + "font", + "format", + "formatsrc", + "height", + "line", + "prefix", + "prefixsrc", + "suffix", + "suffixsrc", + "values", + "valuessrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans two or more lines (i.e. `text` + contains one or more
HTML tags) or if an explicit width is + set to override the text width. + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.cells.Fill` + - A dict of string/value properties that will be passed + to the Fill constructor + + Returns + ------- + plotly.graph_objs.table.cells.Fill + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def font(self): + """ + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.cells.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.table.cells.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def format(self): + """ + Sets the cell value formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'format' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["format"] + + @format.setter + def format(self, val): + self["format"] = val + + @property + def formatsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `format`. + + The 'formatsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["formatsrc"] + + @formatsrc.setter + def formatsrc(self, val): + self["formatsrc"] = val + + @property + def height(self): + """ + The height of cells. + + The 'height' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["height"] + + @height.setter + def height(self, val): + self["height"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.cells.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.table.cells.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def prefix(self): + """ + Prefix for cell values. + + The 'prefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["prefix"] + + @prefix.setter + def prefix(self, val): + self["prefix"] = val + + @property + def prefixsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `prefix`. + + The 'prefixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["prefixsrc"] + + @prefixsrc.setter + def prefixsrc(self, val): + self["prefixsrc"] = val + + @property + def suffix(self): + """ + Suffix for cell values. + + The 'suffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["suffix"] + + @suffix.setter + def suffix(self, val): + self["suffix"] = val + + @property + def suffixsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `suffix`. + + The 'suffixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["suffixsrc"] + + @suffixsrc.setter + def suffixsrc(self, val): + self["suffixsrc"] = val + + @property + def values(self): + """ + Cell values. `values[m][n]` represents the value of the `n`th + point in column `m`, therefore the `values[m]` vector length + for all columns must be the same (longer vectors will be + truncated). Each value must be a finite number or a string. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + fill + :class:`plotly.graph_objects.table.cells.Fill` instance + or dict with compatible properties + font + :class:`plotly.graph_objects.table.cells.Font` instance + or dict with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + formatsrc + Sets the source reference on Chart Studio Cloud for + `format`. + height + The height of cells. + line + :class:`plotly.graph_objects.table.cells.Line` instance + or dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on Chart Studio Cloud for + `prefix`. + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on Chart Studio Cloud for + `suffix`. + values + Cell values. `values[m][n]` represents the value of the + `n`th point in column `m`, therefore the `values[m]` + vector length for all columns must be the same (longer + vectors will be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + fill=None, + font=None, + format=None, + formatsrc=None, + height=None, + line=None, + prefix=None, + prefixsrc=None, + suffix=None, + suffixsrc=None, + values=None, + valuessrc=None, + **kwargs, + ): + """ + Construct a new Cells object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.table.Cells` + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + fill + :class:`plotly.graph_objects.table.cells.Fill` instance + or dict with compatible properties + font + :class:`plotly.graph_objects.table.cells.Font` instance + or dict with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + formatsrc + Sets the source reference on Chart Studio Cloud for + `format`. + height + The height of cells. + line + :class:`plotly.graph_objects.table.cells.Line` instance + or dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on Chart Studio Cloud for + `prefix`. + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on Chart Studio Cloud for + `suffix`. + values + Cell values. `values[m][n]` represents the value of the + `n`th point in column `m`, therefore the `values[m]` + vector length for all columns must be the same (longer + vectors will be truncated). Each value must be a finite + number or a string. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + + Returns + ------- + Cells + """ + super().__init__("cells") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.Cells +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.Cells`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("fill", arg, fill) + self._set_property("font", arg, font) + self._set_property("format", arg, format) + self._set_property("formatsrc", arg, formatsrc) + self._set_property("height", arg, height) + self._set_property("line", arg, line) + self._set_property("prefix", arg, prefix) + self._set_property("prefixsrc", arg, prefixsrc) + self._set_property("suffix", arg, suffix) + self._set_property("suffixsrc", arg, suffixsrc) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_domain.py new file mode 100644 index 0000000..5cc3241 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_domain.py @@ -0,0 +1,169 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "table" + _path_str = "table.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this table trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this table trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this table trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this table trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this table trace . + row + If there is a layout grid, use the domain for this row + in the grid for this table trace . + x + Sets the horizontal domain of this table trace (in plot + fraction). + y + Sets the vertical domain of this table trace (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.table.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this table trace . + row + If there is a layout grid, use the domain for this row + in the grid for this table trace . + x + Sets the horizontal domain of this table trace (in plot + fraction). + y + Sets the vertical domain of this table trace (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_header.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_header.py new file mode 100644 index 0000000..5a4f6f6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_header.py @@ -0,0 +1,464 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Header(_BaseTraceHierarchyType): + _parent_path_str = "table" + _path_str = "table.header" + _valid_props = { + "align", + "alignsrc", + "fill", + "font", + "format", + "formatsrc", + "height", + "line", + "prefix", + "prefixsrc", + "suffix", + "suffixsrc", + "values", + "valuessrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the `text` within the box. Has + an effect only if `text` spans two or more lines (i.e. `text` + contains one or more
HTML tags) or if an explicit width is + set to override the text width. + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def fill(self): + """ + The 'fill' property is an instance of Fill + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.header.Fill` + - A dict of string/value properties that will be passed + to the Fill constructor + + Returns + ------- + plotly.graph_objs.table.header.Fill + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def font(self): + """ + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.header.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.table.header.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def format(self): + """ + Sets the cell value formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + + The 'format' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["format"] + + @format.setter + def format(self, val): + self["format"] = val + + @property + def formatsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `format`. + + The 'formatsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["formatsrc"] + + @formatsrc.setter + def formatsrc(self, val): + self["formatsrc"] = val + + @property + def height(self): + """ + The height of cells. + + The 'height' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["height"] + + @height.setter + def height(self, val): + self["height"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.header.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.table.header.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def prefix(self): + """ + Prefix for cell values. + + The 'prefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["prefix"] + + @prefix.setter + def prefix(self, val): + self["prefix"] = val + + @property + def prefixsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `prefix`. + + The 'prefixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["prefixsrc"] + + @prefixsrc.setter + def prefixsrc(self, val): + self["prefixsrc"] = val + + @property + def suffix(self): + """ + Suffix for cell values. + + The 'suffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["suffix"] + + @suffix.setter + def suffix(self, val): + self["suffix"] = val + + @property + def suffixsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `suffix`. + + The 'suffixsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["suffixsrc"] + + @suffixsrc.setter + def suffixsrc(self, val): + self["suffixsrc"] = val + + @property + def values(self): + """ + Header cell values. `values[m][n]` represents the value of the + `n`th point in column `m`, therefore the `values[m]` vector + length for all columns must be the same (longer vectors will be + truncated). Each value must be a finite number or a string. + + The 'values' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["values"] + + @values.setter + def values(self, val): + self["values"] = val + + @property + def valuessrc(self): + """ + Sets the source reference on Chart Studio Cloud for `values`. + + The 'valuessrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["valuessrc"] + + @valuessrc.setter + def valuessrc(self, val): + self["valuessrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + fill + :class:`plotly.graph_objects.table.header.Fill` + instance or dict with compatible properties + font + :class:`plotly.graph_objects.table.header.Font` + instance or dict with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + formatsrc + Sets the source reference on Chart Studio Cloud for + `format`. + height + The height of cells. + line + :class:`plotly.graph_objects.table.header.Line` + instance or dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on Chart Studio Cloud for + `prefix`. + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on Chart Studio Cloud for + `suffix`. + values + Header cell values. `values[m][n]` represents the value + of the `n`th point in column `m`, therefore the + `values[m]` vector length for all columns must be the + same (longer vectors will be truncated). Each value + must be a finite number or a string. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + fill=None, + font=None, + format=None, + formatsrc=None, + height=None, + line=None, + prefix=None, + prefixsrc=None, + suffix=None, + suffixsrc=None, + values=None, + valuessrc=None, + **kwargs, + ): + """ + Construct a new Header object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.table.Header` + align + Sets the horizontal alignment of the `text` within the + box. Has an effect only if `text` spans two or more + lines (i.e. `text` contains one or more
HTML tags) + or if an explicit width is set to override the text + width. + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + fill + :class:`plotly.graph_objects.table.header.Fill` + instance or dict with compatible properties + font + :class:`plotly.graph_objects.table.header.Font` + instance or dict with compatible properties + format + Sets the cell value formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + formatsrc + Sets the source reference on Chart Studio Cloud for + `format`. + height + The height of cells. + line + :class:`plotly.graph_objects.table.header.Line` + instance or dict with compatible properties + prefix + Prefix for cell values. + prefixsrc + Sets the source reference on Chart Studio Cloud for + `prefix`. + suffix + Suffix for cell values. + suffixsrc + Sets the source reference on Chart Studio Cloud for + `suffix`. + values + Header cell values. `values[m][n]` represents the value + of the `n`th point in column `m`, therefore the + `values[m]` vector length for all columns must be the + same (longer vectors will be truncated). Each value + must be a finite number or a string. + valuessrc + Sets the source reference on Chart Studio Cloud for + `values`. + + Returns + ------- + Header + """ + super().__init__("header") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.Header +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.Header`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("fill", arg, fill) + self._set_property("font", arg, font) + self._set_property("format", arg, format) + self._set_property("formatsrc", arg, formatsrc) + self._set_property("height", arg, height) + self._set_property("line", arg, line) + self._set_property("prefix", arg, prefix) + self._set_property("prefixsrc", arg, prefixsrc) + self._set_property("suffix", arg, suffix) + self._set_property("suffixsrc", arg, suffixsrc) + self._set_property("values", arg, values) + self._set_property("valuessrc", arg, valuessrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_hoverlabel.py new file mode 100644 index 0000000..3f41e95 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "table" + _path_str = "table.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.table.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_legendgrouptitle.py new file mode 100644 index 0000000..3ce6859 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "table" + _path_str = "table.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.table.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.table.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_stream.py new file mode 100644 index 0000000..24b93ee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "table" + _path_str = "table.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.table.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/__init__.py new file mode 100644 index 0000000..803b7c1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._fill import Fill + from ._font import Font + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._fill.Fill", "._font.Font", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_fill.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_fill.py new file mode 100644 index 0000000..7767853 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_fill.py @@ -0,0 +1,110 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Fill(_BaseTraceHierarchyType): + _parent_path_str = "table.cells" + _path_str = "table.cells.fill" + _valid_props = {"color", "colorsrc"} + + @property + def color(self): + """ + Sets the cell fill color. It accepts either a specific color or + an array of colors or a 2D array of colors. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.cells.Fill` + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + + Returns + ------- + Fill + """ + super().__init__("fill") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.cells.Fill +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.cells.Fill`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_font.py new file mode 100644 index 0000000..c0f59ea --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_font.py @@ -0,0 +1,585 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "table.cells" + _path_str = "table.cells.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.cells.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.cells.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.cells.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_line.py new file mode 100644 index 0000000..9158331 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/cells/_line.py @@ -0,0 +1,154 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "table.cells" + _path_str = "table.cells.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + The 'width' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.cells.Line` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.cells.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.cells.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/__init__.py new file mode 100644 index 0000000..803b7c1 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._fill import Fill + from ._font import Font + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._fill.Fill", "._font.Font", "._line.Line"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_fill.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_fill.py new file mode 100644 index 0000000..156dd95 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_fill.py @@ -0,0 +1,110 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Fill(_BaseTraceHierarchyType): + _parent_path_str = "table.header" + _path_str = "table.header.fill" + _valid_props = {"color", "colorsrc"} + + @property + def color(self): + """ + Sets the cell fill color. It accepts either a specific color or + an array of colors or a 2D array of colors. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + """ + + def __init__(self, arg=None, color=None, colorsrc=None, **kwargs): + """ + Construct a new Fill object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.header.Fill` + color + Sets the cell fill color. It accepts either a specific + color or an array of colors or a 2D array of colors. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + + Returns + ------- + Fill + """ + super().__init__("fill") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.header.Fill +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.header.Fill`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_font.py new file mode 100644 index 0000000..7b39fc0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_font.py @@ -0,0 +1,585 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "table.header" + _path_str = "table.header.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.header.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.header.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.header.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_line.py new file mode 100644 index 0000000..0c7e311 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/header/_line.py @@ -0,0 +1,154 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "table.header" + _path_str = "table.header.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + The 'width' property is a number and may be specified as: + - An int or float + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.header.Line` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.header.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.header.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/_font.py new file mode 100644 index 0000000..d43a1e2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "table.hoverlabel" + _path_str = "table.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/_font.py new file mode 100644 index 0000000..8111db0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/table/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "table.legendgrouptitle" + _path_str = "table.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.table.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.table.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.table.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/__init__.py new file mode 100644 index 0000000..2387dd3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/__init__.py @@ -0,0 +1,39 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._domain import Domain + from ._hoverlabel import Hoverlabel + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._marker import Marker + from ._outsidetextfont import Outsidetextfont + from ._pathbar import Pathbar + from ._root import Root + from ._stream import Stream + from ._textfont import Textfont + from ._tiling import Tiling + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import pathbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".hoverlabel", ".legendgrouptitle", ".marker", ".pathbar"], + [ + "._domain.Domain", + "._hoverlabel.Hoverlabel", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._marker.Marker", + "._outsidetextfont.Outsidetextfont", + "._pathbar.Pathbar", + "._root.Root", + "._stream.Stream", + "._textfont.Textfont", + "._tiling.Tiling", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_domain.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_domain.py new file mode 100644 index 0000000..21b63ad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_domain.py @@ -0,0 +1,170 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Domain(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.domain" + _valid_props = {"column", "row", "x", "y"} + + @property + def column(self): + """ + If there is a layout grid, use the domain for this column in + the grid for this treemap trace . + + The 'column' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["column"] + + @column.setter + def column(self, val): + self["column"] = val + + @property + def row(self): + """ + If there is a layout grid, use the domain for this row in the + grid for this treemap trace . + + The 'row' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["row"] + + @row.setter + def row(self, val): + self["row"] = val + + @property + def x(self): + """ + Sets the horizontal domain of this treemap trace (in plot + fraction). + + The 'x' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'x[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'x[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Sets the vertical domain of this treemap trace (in plot + fraction). + + The 'y' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'y[0]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + (1) The 'y[1]' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + list + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def _prop_descriptions(self): + return """\ + column + If there is a layout grid, use the domain for this + column in the grid for this treemap trace . + row + If there is a layout grid, use the domain for this row + in the grid for this treemap trace . + x + Sets the horizontal domain of this treemap trace (in + plot fraction). + y + Sets the vertical domain of this treemap trace (in plot + fraction). + """ + + def __init__(self, arg=None, column=None, row=None, x=None, y=None, **kwargs): + """ + Construct a new Domain object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Domain` + column + If there is a layout grid, use the domain for this + column in the grid for this treemap trace . + row + If there is a layout grid, use the domain for this row + in the grid for this treemap trace . + x + Sets the horizontal domain of this treemap trace (in + plot fraction). + y + Sets the vertical domain of this treemap trace (in plot + fraction). + + Returns + ------- + Domain + """ + super().__init__("domain") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Domain +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Domain`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("column", arg, column) + self._set_property("row", arg, row) + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_hoverlabel.py new file mode 100644 index 0000000..a513118 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.treemap.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_insidetextfont.py new file mode 100644 index 0000000..2587366 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `textinfo` lying inside the sector. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_legendgrouptitle.py new file mode 100644 index 0000000..8a630dc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.treemap.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_marker.py new file mode 100644 index 0000000..2d2af08 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_marker.py @@ -0,0 +1,681 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.marker" + _valid_props = { + "autocolorscale", + "cauto", + "cmax", + "cmid", + "cmin", + "coloraxis", + "colorbar", + "colors", + "colorscale", + "colorssrc", + "cornerradius", + "depthfade", + "line", + "pad", + "pattern", + "reversescale", + "showscale", + } + + @property + def autocolorscale(self): + """ + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is set to a + numerical array. In case `colorscale` is unspecified or + `autocolorscale` is true, the default palette will be chosen + according to whether numbers in the `color` array are all + positive, all negative or mixed. + + The 'autocolorscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["autocolorscale"] + + @autocolorscale.setter + def autocolorscale(self, val): + self["autocolorscale"] = val + + @property + def cauto(self): + """ + Determines whether or not the color domain is computed with + respect to the input data (here colors) or the bounds set in + `marker.cmin` and `marker.cmax` Has an effect only if colors is + set to a numerical array. Defaults to `false` when + `marker.cmin` and `marker.cmax` are set by the user. + + The 'cauto' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["cauto"] + + @cauto.setter + def cauto(self, val): + self["cauto"] = val + + @property + def cmax(self): + """ + Sets the upper bound of the color domain. Has an effect only if + colors is set to a numerical array. Value should have the same + units as colors and if set, `marker.cmin` must be set as well. + + The 'cmax' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmax"] + + @cmax.setter + def cmax(self, val): + self["cmax"] = val + + @property + def cmid(self): + """ + Sets the mid-point of the color domain by scaling `marker.cmin` + and/or `marker.cmax` to be equidistant to this point. Has an + effect only if colors is set to a numerical array. Value should + have the same units as colors. Has no effect when + `marker.cauto` is `false`. + + The 'cmid' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmid"] + + @cmid.setter + def cmid(self, val): + self["cmid"] = val + + @property + def cmin(self): + """ + Sets the lower bound of the color domain. Has an effect only if + colors is set to a numerical array. Value should have the same + units as colors and if set, `marker.cmax` must be set as well. + + The 'cmin' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["cmin"] + + @cmin.setter + def cmin(self, val): + self["cmin"] = val + + @property + def coloraxis(self): + """ + 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 `layout.coloraxis`, `layout.coloraxis2`, etc. + Note that multiple color scales can be linked to the same color + axis. + + The 'coloraxis' property is an identifier of a particular + subplot, of type 'coloraxis', that may be specified as the string 'coloraxis' + optionally followed by an integer >= 1 + (e.g. 'coloraxis', 'coloraxis1', 'coloraxis2', 'coloraxis3', etc.) + + Returns + ------- + str + """ + return self["coloraxis"] + + @coloraxis.setter + def coloraxis(self, val): + self["coloraxis"] = val + + @property + def colorbar(self): + """ + The 'colorbar' property is an instance of ColorBar + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.ColorBar` + - A dict of string/value properties that will be passed + to the ColorBar constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.ColorBar + """ + return self["colorbar"] + + @colorbar.setter + def colorbar(self, val): + self["colorbar"] = val + + @property + def colors(self): + """ + Sets the color of each sector of this trace. If not specified, + the default trace color set is used to pick the sector colors. + + The 'colors' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["colors"] + + @colors.setter + def colors(self, val): + self["colors"] = val + + @property + def colorscale(self): + """ + Sets the colorscale. Has an effect only if colors is set to a + numerical array. 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, + `[[0, 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use `marker.cmin` and + `marker.cmax`. Alternatively, `colorscale` may be a palette + name string of the following list: Blackbody,Bluered,Blues,Civi + dis,Earth,Electric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow + ,RdBu,Reds,Viridis,YlGnBu,YlOrRd. + + The 'colorscale' property is a colorscale and may be + specified as: + - A list of colors that will be spaced evenly to create the colorscale. + Many predefined colorscale lists are included in the sequential, diverging, + and cyclical modules in the plotly.colors package. + - A list of 2-element lists where the first element is the + normalized color level value (starting at 0 and ending at 1), + and the second item is a valid color string. + (e.g. [[0, 'green'], [0.5, 'red'], [1.0, 'rgb(0, 0, 255)']]) + - One of the following named colorscales: + ['aggrnyl', 'agsunset', 'algae', 'amp', 'armyrose', 'balance', + 'blackbody', 'bluered', 'blues', 'blugrn', 'bluyl', 'brbg', + 'brwnyl', 'bugn', 'bupu', 'burg', 'burgyl', 'cividis', 'curl', + 'darkmint', 'deep', 'delta', 'dense', 'earth', 'edge', 'electric', + 'emrld', 'fall', 'geyser', 'gnbu', 'gray', 'greens', 'greys', + 'haline', 'hot', 'hsv', 'ice', 'icefire', 'inferno', 'jet', + 'magenta', 'magma', 'matter', 'mint', 'mrybm', 'mygbm', 'oranges', + 'orrd', 'oryel', 'oxy', 'peach', 'phase', 'picnic', 'pinkyl', + 'piyg', 'plasma', 'plotly3', 'portland', 'prgn', 'pubu', 'pubugn', + 'puor', 'purd', 'purp', 'purples', 'purpor', 'rainbow', 'rdbu', + 'rdgy', 'rdpu', 'rdylbu', 'rdylgn', 'redor', 'reds', 'solar', + 'spectral', 'speed', 'sunset', 'sunsetdark', 'teal', 'tealgrn', + 'tealrose', 'tempo', 'temps', 'thermal', 'tropic', 'turbid', + 'turbo', 'twilight', 'viridis', 'ylgn', 'ylgnbu', 'ylorbr', + 'ylorrd']. + Appending '_r' to a named colorscale reverses it. + + Returns + ------- + str + """ + return self["colorscale"] + + @colorscale.setter + def colorscale(self, val): + self["colorscale"] = val + + @property + def colorssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `colors`. + + The 'colorssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorssrc"] + + @colorssrc.setter + def colorssrc(self, val): + self["colorssrc"] = val + + @property + def cornerradius(self): + """ + Sets the maximum rounding of corners (in px). + + The 'cornerradius' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["cornerradius"] + + @cornerradius.setter + def cornerradius(self, val): + self["cornerradius"] = val + + @property + def depthfade(self): + """ + Determines if the sector colors are faded towards the + background from the leaves up to the headers. This option is + unavailable when a `colorscale` is present, defaults to false + when `marker.colors` is set, but otherwise defaults to true. + When set to "reversed", the fading direction is inverted, that + is the top elements within hierarchy are drawn with fully + saturated colors while the leaves are faded towards the + background color. + + The 'depthfade' property is an enumeration that may be specified as: + - One of the following enumeration values: + [True, False, 'reversed'] + + Returns + ------- + Any + """ + return self["depthfade"] + + @depthfade.setter + def depthfade(self, val): + self["depthfade"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def pad(self): + """ + The 'pad' property is an instance of Pad + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.Pad` + - A dict of string/value properties that will be passed + to the Pad constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.Pad + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def pattern(self): + """ + Sets the pattern within the marker. + + The 'pattern' property is an instance of Pattern + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.Pattern` + - A dict of string/value properties that will be passed + to the Pattern constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.Pattern + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def reversescale(self): + """ + Reverses the color mapping if true. Has an effect only if + colors is set to a numerical array. If true, `marker.cmin` will + correspond to the last color in the array and `marker.cmax` + will correspond to the first color. + + The 'reversescale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["reversescale"] + + @reversescale.setter + def reversescale(self, val): + self["reversescale"] = val + + @property + def showscale(self): + """ + Determines whether or not a colorbar is displayed for this + trace. Has an effect only if colors is set to a numerical + array. + + The 'showscale' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showscale"] + + @showscale.setter + def showscale(self, val): + self["showscale"] = val + + @property + def _prop_descriptions(self): + return """\ + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is + set to a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the default + palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or + mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here colors) or the + bounds set in `marker.cmin` and `marker.cmax` Has an + effect only if colors is set to a numerical array. + Defaults to `false` when `marker.cmin` and + `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if colors is set to a + numerical array. Value should have the same units as + colors. Has no effect when `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.treemap.marker.ColorBar` + instance or dict with compatible properties + colors + Sets the color of each sector of this trace. If not + specified, the default trace color set is used to pick + the sector colors. + colorscale + Sets the colorscale. Has an effect only if colors is + set to a numerical array. 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, `[[0, + 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + cornerradius + Sets the maximum rounding of corners (in px). + depthfade + Determines if the sector colors are faded towards the + background from the leaves up to the headers. This + option is unavailable when a `colorscale` is present, + defaults to false when `marker.colors` is set, but + otherwise defaults to true. When set to "reversed", the + fading direction is inverted, that is the top elements + within hierarchy are drawn with fully saturated colors + while the leaves are faded towards the background + color. + line + :class:`plotly.graph_objects.treemap.marker.Line` + instance or dict with compatible properties + pad + :class:`plotly.graph_objects.treemap.marker.Pad` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if colors is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the + array and `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if colors is set to a + numerical array. + """ + + def __init__( + self, + arg=None, + autocolorscale=None, + cauto=None, + cmax=None, + cmid=None, + cmin=None, + coloraxis=None, + colorbar=None, + colors=None, + colorscale=None, + colorssrc=None, + cornerradius=None, + depthfade=None, + line=None, + pad=None, + pattern=None, + reversescale=None, + showscale=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Marker` + autocolorscale + Determines whether the colorscale is a default palette + (`autocolorscale: true`) or the palette determined by + `marker.colorscale`. Has an effect only if colors is + set to a numerical array. In case `colorscale` is + unspecified or `autocolorscale` is true, the default + palette will be chosen according to whether numbers in + the `color` array are all positive, all negative or + mixed. + cauto + Determines whether or not the color domain is computed + with respect to the input data (here colors) or the + bounds set in `marker.cmin` and `marker.cmax` Has an + effect only if colors is set to a numerical array. + Defaults to `false` when `marker.cmin` and + `marker.cmax` are set by the user. + cmax + Sets the upper bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmin` must be set as well. + cmid + Sets the mid-point of the color domain by scaling + `marker.cmin` and/or `marker.cmax` to be equidistant to + this point. Has an effect only if colors is set to a + numerical array. Value should have the same units as + colors. Has no effect when `marker.cauto` is `false`. + cmin + Sets the lower bound of the color domain. Has an effect + only if colors is set to a numerical array. Value + should have the same units as colors and if set, + `marker.cmax` must be set as well. + 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 `layout.coloraxis`, + `layout.coloraxis2`, etc. Note that multiple color + scales can be linked to the same color axis. + colorbar + :class:`plotly.graph_objects.treemap.marker.ColorBar` + instance or dict with compatible properties + colors + Sets the color of each sector of this trace. If not + specified, the default trace color set is used to pick + the sector colors. + colorscale + Sets the colorscale. Has an effect only if colors is + set to a numerical array. 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, `[[0, + 'rgb(0,0,255)'], [1, 'rgb(255,0,0)']]`. To control the + bounds of the colorscale in color space, use + `marker.cmin` and `marker.cmax`. Alternatively, + `colorscale` may be a palette name string of the + following list: Blackbody,Bluered,Blues,Cividis,Earth,E + lectric,Greens,Greys,Hot,Jet,Picnic,Portland,Rainbow,Rd + Bu,Reds,Viridis,YlGnBu,YlOrRd. + colorssrc + Sets the source reference on Chart Studio Cloud for + `colors`. + cornerradius + Sets the maximum rounding of corners (in px). + depthfade + Determines if the sector colors are faded towards the + background from the leaves up to the headers. This + option is unavailable when a `colorscale` is present, + defaults to false when `marker.colors` is set, but + otherwise defaults to true. When set to "reversed", the + fading direction is inverted, that is the top elements + within hierarchy are drawn with fully saturated colors + while the leaves are faded towards the background + color. + line + :class:`plotly.graph_objects.treemap.marker.Line` + instance or dict with compatible properties + pad + :class:`plotly.graph_objects.treemap.marker.Pad` + instance or dict with compatible properties + pattern + Sets the pattern within the marker. + reversescale + Reverses the color mapping if true. Has an effect only + if colors is set to a numerical array. If true, + `marker.cmin` will correspond to the last color in the + array and `marker.cmax` will correspond to the first + color. + showscale + Determines whether or not a colorbar is displayed for + this trace. Has an effect only if colors is set to a + numerical array. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("autocolorscale", arg, autocolorscale) + self._set_property("cauto", arg, cauto) + self._set_property("cmax", arg, cmax) + self._set_property("cmid", arg, cmid) + self._set_property("cmin", arg, cmin) + self._set_property("coloraxis", arg, coloraxis) + self._set_property("colorbar", arg, colorbar) + self._set_property("colors", arg, colors) + self._set_property("colorscale", arg, colorscale) + self._set_property("colorssrc", arg, colorssrc) + self._set_property("cornerradius", arg, cornerradius) + self._set_property("depthfade", arg, depthfade) + self._set_property("line", arg, line) + self._set_property("pad", arg, pad) + self._set_property("pattern", arg, pattern) + self._set_property("reversescale", arg, reversescale) + self._set_property("showscale", arg, showscale) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_outsidetextfont.py new file mode 100644 index 0000000..2bbe923 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_outsidetextfont.py @@ -0,0 +1,591 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `textinfo` lying outside the sector. + This option refers to the root of the hierarchy presented on + top left corner of a treemap graph. Please note that if a + hierarchy has multiple root nodes, this option won't have any + effect and `insidetextfont` would be used. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_pathbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_pathbar.py new file mode 100644 index 0000000..295cc48 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_pathbar.py @@ -0,0 +1,198 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pathbar(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.pathbar" + _valid_props = {"edgeshape", "side", "textfont", "thickness", "visible"} + + @property + def edgeshape(self): + """ + Determines which shape is used for edges between `barpath` + labels. + + The 'edgeshape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['>', '<', '|', '/', '\\'] + + Returns + ------- + Any + """ + return self["edgeshape"] + + @edgeshape.setter + def edgeshape(self, val): + self["edgeshape"] = val + + @property + def side(self): + """ + Determines on which side of the the treemap the `pathbar` + should be presented. + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def textfont(self): + """ + Sets the font used inside `pathbar`. + + The 'textfont' property is an instance of Textfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.pathbar.Textfont` + - A dict of string/value properties that will be passed + to the Textfont constructor + + Returns + ------- + plotly.graph_objs.treemap.pathbar.Textfont + """ + return self["textfont"] + + @textfont.setter + def textfont(self, val): + self["textfont"] = val + + @property + def thickness(self): + """ + Sets the thickness of `pathbar` (in px). If not specified the + `pathbar.textfont.size` is used with 3 pixles extra padding on + each side. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [12, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def visible(self): + """ + Determines if the path bar is drawn i.e. outside the trace + `domain` and with one pixel gap. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + edgeshape + Determines which shape is used for edges between + `barpath` labels. + side + Determines on which side of the the treemap the + `pathbar` should be presented. + textfont + Sets the font used inside `pathbar`. + thickness + Sets the thickness of `pathbar` (in px). If not + specified the `pathbar.textfont.size` is used with 3 + pixles extra padding on each side. + visible + Determines if the path bar is drawn i.e. outside the + trace `domain` and with one pixel gap. + """ + + def __init__( + self, + arg=None, + edgeshape=None, + side=None, + textfont=None, + thickness=None, + visible=None, + **kwargs, + ): + """ + Construct a new Pathbar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Pathbar` + edgeshape + Determines which shape is used for edges between + `barpath` labels. + side + Determines on which side of the the treemap the + `pathbar` should be presented. + textfont + Sets the font used inside `pathbar`. + thickness + Sets the thickness of `pathbar` (in px). If not + specified the `pathbar.textfont.size` is used with 3 + pixles extra padding on each side. + visible + Determines if the path bar is drawn i.e. outside the + trace `domain` and with one pixel gap. + + Returns + ------- + Pathbar + """ + super().__init__("pathbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Pathbar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Pathbar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("edgeshape", arg, edgeshape) + self._set_property("side", arg, side) + self._set_property("textfont", arg, textfont) + self._set_property("thickness", arg, thickness) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_root.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_root.py new file mode 100644 index 0000000..9ab16ee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_root.py @@ -0,0 +1,86 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Root(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.root" + _valid_props = {"color"} + + @property + def color(self): + """ + sets the color of the root node for a sunburst/treemap/icicle + trace. this has no effect when a colorscale is used to set the + markers. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def _prop_descriptions(self): + return """\ + color + sets the color of the root node for a + sunburst/treemap/icicle trace. this has no effect when + a colorscale is used to set the markers. + """ + + def __init__(self, arg=None, color=None, **kwargs): + """ + Construct a new Root object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.treemap.Root` + color + sets the color of the root node for a + sunburst/treemap/icicle trace. this has no effect when + a colorscale is used to set the markers. + + Returns + ------- + Root + """ + super().__init__("root") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Root +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Root`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_stream.py new file mode 100644 index 0000000..54bbfd7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_textfont.py new file mode 100644 index 0000000..16f5ef0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `textinfo`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_tiling.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_tiling.py new file mode 100644 index 0000000..36d677e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/_tiling.py @@ -0,0 +1,195 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tiling(_BaseTraceHierarchyType): + _parent_path_str = "treemap" + _path_str = "treemap.tiling" + _valid_props = {"flip", "packing", "pad", "squarifyratio"} + + @property + def flip(self): + """ + Determines if the positions obtained from solver are flipped on + each axis. + + The 'flip' property is a flaglist and may be specified + as a string containing: + - Any combination of ['x', 'y'] joined with '+' characters + (e.g. 'x+y') + + Returns + ------- + Any + """ + return self["flip"] + + @flip.setter + def flip(self, val): + self["flip"] = val + + @property + def packing(self): + """ + Determines d3 treemap solver. For more info please refer to + https://github.com/d3/d3-hierarchy#treemap-tiling + + The 'packing' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['squarify', 'binary', 'dice', 'slice', 'slice-dice', + 'dice-slice'] + + Returns + ------- + Any + """ + return self["packing"] + + @packing.setter + def packing(self, val): + self["packing"] = val + + @property + def pad(self): + """ + Sets the inner padding (in px). + + The 'pad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["pad"] + + @pad.setter + def pad(self, val): + self["pad"] = val + + @property + def squarifyratio(self): + """ + When using "squarify" `packing` algorithm, according to https:/ + /github.com/d3/d3- + hierarchy/blob/v3.1.1/README.md#squarify_ratio this option + specifies the desired aspect ratio of the generated rectangles. + The ratio must be specified as a number greater than or equal + to one. Note that the orientation of the generated rectangles + (tall or wide) is not implied by the ratio; for example, a + ratio of two will attempt to produce a mixture of rectangles + whose width:height ratio is either 2:1 or 1:2. When using + "squarify", unlike d3 which uses the Golden Ratio i.e. + 1.618034, Plotly applies 1 to increase squares in treemap + layouts. + + The 'squarifyratio' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["squarifyratio"] + + @squarifyratio.setter + def squarifyratio(self, val): + self["squarifyratio"] = val + + @property + def _prop_descriptions(self): + return """\ + flip + Determines if the positions obtained from solver are + flipped on each axis. + packing + Determines d3 treemap solver. For more info please + refer to https://github.com/d3/d3-hierarchy#treemap- + tiling + pad + Sets the inner padding (in px). + squarifyratio + When using "squarify" `packing` algorithm, according to + https://github.com/d3/d3- + hierarchy/blob/v3.1.1/README.md#squarify_ratio this + option specifies the desired aspect ratio of the + generated rectangles. The ratio must be specified as a + number greater than or equal to one. Note that the + orientation of the generated rectangles (tall or wide) + is not implied by the ratio; for example, a ratio of + two will attempt to produce a mixture of rectangles + whose width:height ratio is either 2:1 or 1:2. When + using "squarify", unlike d3 which uses the Golden Ratio + i.e. 1.618034, Plotly applies 1 to increase squares in + treemap layouts. + """ + + def __init__( + self, arg=None, flip=None, packing=None, pad=None, squarifyratio=None, **kwargs + ): + """ + Construct a new Tiling object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.Tiling` + flip + Determines if the positions obtained from solver are + flipped on each axis. + packing + Determines d3 treemap solver. For more info please + refer to https://github.com/d3/d3-hierarchy#treemap- + tiling + pad + Sets the inner padding (in px). + squarifyratio + When using "squarify" `packing` algorithm, according to + https://github.com/d3/d3- + hierarchy/blob/v3.1.1/README.md#squarify_ratio this + option specifies the desired aspect ratio of the + generated rectangles. The ratio must be specified as a + number greater than or equal to one. Note that the + orientation of the generated rectangles (tall or wide) + is not implied by the ratio; for example, a ratio of + two will attempt to produce a mixture of rectangles + whose width:height ratio is either 2:1 or 1:2. When + using "squarify", unlike d3 which uses the Golden Ratio + i.e. 1.618034, Plotly applies 1 to increase squares in + treemap layouts. + + Returns + ------- + Tiling + """ + super().__init__("tiling") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.Tiling +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.Tiling`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("flip", arg, flip) + self._set_property("packing", arg, packing) + self._set_property("pad", arg, pad) + self._set_property("squarifyratio", arg, squarifyratio) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/_font.py new file mode 100644 index 0000000..106b281 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "treemap.hoverlabel" + _path_str = "treemap.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/_font.py new file mode 100644 index 0000000..d0cda3d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "treemap.legendgrouptitle" + _path_str = "treemap.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.treemap.legend + grouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/__init__.py new file mode 100644 index 0000000..a3eae49 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/__init__.py @@ -0,0 +1,17 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._colorbar import ColorBar + from ._line import Line + from ._pad import Pad + from ._pattern import Pattern + from . import colorbar +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".colorbar"], + ["._colorbar.ColorBar", "._line.Line", "._pad.Pad", "._pattern.Pattern"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_colorbar.py new file mode 100644 index 0000000..a59fb86 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker" + _path_str = "treemap.marker.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.treemap.marker.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.treemap.marker.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as layout.template.data.treemap.marker + .colorbar.tickformatstopdefaults), sets the default property + values to use for elements of + treemap.marker.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.treemap.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.treema + p.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + treemap.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.treemap.marker.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.marker.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.treemap.marker. + colorbar.Tickformatstop` instances or dicts with + compatible properties + tickformatstopdefaults + When used in a template (as layout.template.data.treema + p.marker.colorbar.tickformatstopdefaults), sets the + default property values to use for elements of + treemap.marker.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.treemap.marker.colorbar.Ti + tle` instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_line.py new file mode 100644 index 0000000..59f149a --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_line.py @@ -0,0 +1,163 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker" + _path_str = "treemap.marker.line" + _valid_props = {"color", "colorsrc", "width", "widthsrc"} + + @property + def color(self): + """ + Sets the color of the line enclosing each sector. Defaults to + the `paper_bgcolor` value. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def width(self): + """ + Sets the width (in px) of the line enclosing each sector. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def widthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `width`. + + The 'widthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["widthsrc"] + + @widthsrc.setter + def widthsrc(self, val): + self["widthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + """ + + def __init__( + self, arg=None, color=None, colorsrc=None, width=None, widthsrc=None, **kwargs + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.marker.Line` + color + Sets the color of the line enclosing each sector. + Defaults to the `paper_bgcolor` value. + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + width + Sets the width (in px) of the line enclosing each + sector. + widthsrc + Sets the source reference on Chart Studio Cloud for + `width`. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("width", arg, width) + self._set_property("widthsrc", arg, widthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pad.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pad.py new file mode 100644 index 0000000..f3b58b7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pad.py @@ -0,0 +1,146 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pad(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker" + _path_str = "treemap.marker.pad" + _valid_props = {"b", "l", "r", "t"} + + @property + def b(self): + """ + Sets the padding form the bottom (in px). + + The 'b' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["b"] + + @b.setter + def b(self, val): + self["b"] = val + + @property + def l(self): + """ + Sets the padding form the left (in px). + + The 'l' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["l"] + + @l.setter + def l(self, val): + self["l"] = val + + @property + def r(self): + """ + Sets the padding form the right (in px). + + The 'r' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["r"] + + @r.setter + def r(self, val): + self["r"] = val + + @property + def t(self): + """ + Sets the padding form the top (in px). + + The 't' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["t"] + + @t.setter + def t(self, val): + self["t"] = val + + @property + def _prop_descriptions(self): + return """\ + b + Sets the padding form the bottom (in px). + l + Sets the padding form the left (in px). + r + Sets the padding form the right (in px). + t + Sets the padding form the top (in px). + """ + + def __init__(self, arg=None, b=None, l=None, r=None, t=None, **kwargs): + """ + Construct a new Pad object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.marker.Pad` + b + Sets the padding form the bottom (in px). + l + Sets the padding form the left (in px). + r + Sets the padding form the right (in px). + t + Sets the padding form the top (in px). + + Returns + ------- + Pad + """ + super().__init__("pad") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.Pad +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.Pad`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("b", arg, b) + self._set_property("l", arg, l) + self._set_property("r", arg, r) + self._set_property("t", arg, t) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pattern.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pattern.py new file mode 100644 index 0000000..faa03c4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/_pattern.py @@ -0,0 +1,433 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Pattern(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker" + _path_str = "treemap.marker.pattern" + _valid_props = { + "bgcolor", + "bgcolorsrc", + "fgcolor", + "fgcolorsrc", + "fgopacity", + "fillmode", + "shape", + "shapesrc", + "size", + "sizesrc", + "solidity", + "soliditysrc", + } + + @property + def bgcolor(self): + """ + When there is no colorscale sets the color of background + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "overlay". Otherwise, defaults to a transparent + background. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def fgcolor(self): + """ + When there is no colorscale sets the color of foreground + pattern fill. Defaults to a `marker.color` background when + `fillmode` is "replace". Otherwise, defaults to dark grey or + white to increase contrast with the `bgcolor`. + + The 'fgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["fgcolor"] + + @fgcolor.setter + def fgcolor(self, val): + self["fgcolor"] = val + + @property + def fgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `fgcolor`. + + The 'fgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["fgcolorsrc"] + + @fgcolorsrc.setter + def fgcolorsrc(self, val): + self["fgcolorsrc"] = val + + @property + def fgopacity(self): + """ + Sets the opacity of the foreground pattern fill. Defaults to a + 0.5 when `fillmode` is "overlay". Otherwise, defaults to 1. + + The 'fgopacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fgopacity"] + + @fgopacity.setter + def fgopacity(self, val): + self["fgopacity"] = val + + @property + def fillmode(self): + """ + Determines whether `marker.color` should be used as a default + to `bgcolor` or a `fgcolor`. + + The 'fillmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['replace', 'overlay'] + + Returns + ------- + Any + """ + return self["fillmode"] + + @fillmode.setter + def fillmode(self, val): + self["fillmode"] = val + + @property + def shape(self): + """ + Sets the shape of the pattern fill. By default, no pattern is + used for filling the area. + + The 'shape' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['', '/', '\\', 'x', '-', '|', '+', '.'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["shape"] + + @shape.setter + def shape(self, val): + self["shape"] = val + + @property + def shapesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shape`. + + The 'shapesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shapesrc"] + + @shapesrc.setter + def shapesrc(self, val): + self["shapesrc"] = val + + @property + def size(self): + """ + Sets the size of unit squares of the pattern fill in pixels, + which corresponds to the interval of repetition of the pattern. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def solidity(self): + """ + Sets the solidity of the pattern fill. Solidity is roughly the + fraction of the area filled by the pattern. Solidity of 0 shows + only the background color without pattern and solidty of 1 + shows only the foreground color without pattern. + + The 'solidity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["solidity"] + + @solidity.setter + def solidity(self, val): + self["solidity"] = val + + @property + def soliditysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `solidity`. + + The 'soliditysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["soliditysrc"] + + @soliditysrc.setter + def soliditysrc(self, val): + self["soliditysrc"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bgcolorsrc=None, + fgcolor=None, + fgcolorsrc=None, + fgopacity=None, + fillmode=None, + shape=None, + shapesrc=None, + size=None, + sizesrc=None, + solidity=None, + soliditysrc=None, + **kwargs, + ): + """ + Construct a new Pattern object + + Sets the pattern within the marker. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.marker.Pattern` + bgcolor + When there is no colorscale sets the color of + background pattern fill. Defaults to a `marker.color` + background when `fillmode` is "overlay". Otherwise, + defaults to a transparent background. + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + fgcolor + When there is no colorscale sets the color of + foreground pattern fill. Defaults to a `marker.color` + background when `fillmode` is "replace". Otherwise, + defaults to dark grey or white to increase contrast + with the `bgcolor`. + fgcolorsrc + Sets the source reference on Chart Studio Cloud for + `fgcolor`. + fgopacity + Sets the opacity of the foreground pattern fill. + Defaults to a 0.5 when `fillmode` is "overlay". + Otherwise, defaults to 1. + fillmode + Determines whether `marker.color` should be used as a + default to `bgcolor` or a `fgcolor`. + shape + Sets the shape of the pattern fill. By default, no + pattern is used for filling the area. + shapesrc + Sets the source reference on Chart Studio Cloud for + `shape`. + size + Sets the size of unit squares of the pattern fill in + pixels, which corresponds to the interval of repetition + of the pattern. + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + solidity + Sets the solidity of the pattern fill. Solidity is + roughly the fraction of the area filled by the pattern. + Solidity of 0 shows only the background color without + pattern and solidty of 1 shows only the foreground + color without pattern. + soliditysrc + Sets the source reference on Chart Studio Cloud for + `solidity`. + + Returns + ------- + Pattern + """ + super().__init__("pattern") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.Pattern +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.Pattern`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("fgcolor", arg, fgcolor) + self._set_property("fgcolorsrc", arg, fgcolorsrc) + self._set_property("fgopacity", arg, fgopacity) + self._set_property("fillmode", arg, fillmode) + self._set_property("shape", arg, shape) + self._set_property("shapesrc", arg, shapesrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("solidity", arg, solidity) + self._set_property("soliditysrc", arg, soliditysrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py new file mode 100644 index 0000000..54b0173 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker.colorbar" + _path_str = "treemap.marker.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py new file mode 100644 index 0000000..08aeb3e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker.colorbar" + _path_str = "treemap.marker.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_title.py new file mode 100644 index 0000000..9e1633f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker.colorbar" + _path_str = "treemap.marker.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.treemap.marker.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.treemap.marker.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/_font.py new file mode 100644 index 0000000..556b314 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/marker/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "treemap.marker.colorbar.title" + _path_str = "treemap.marker.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.treemap.marker + .colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.marker.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.marker.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/__init__.py new file mode 100644 index 0000000..a713099 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/__init__.py @@ -0,0 +1,11 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._textfont import Textfont +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._textfont.Textfont"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/_textfont.py new file mode 100644 index 0000000..0475771 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/treemap/pathbar/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "treemap.pathbar" + _path_str = "treemap.pathbar.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used inside `pathbar`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.treemap.pathbar.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.treemap.pathbar.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.treemap.pathbar.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/__init__.py new file mode 100644 index 0000000..bcd588d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/__init__.py @@ -0,0 +1,44 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._box import Box + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._line import Line + from ._marker import Marker + from ._meanline import Meanline + from ._selected import Selected + from ._stream import Stream + from ._unselected import Unselected + from . import box + from . import hoverlabel + from . import legendgrouptitle + from . import marker + from . import selected + from . import unselected +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".box", + ".hoverlabel", + ".legendgrouptitle", + ".marker", + ".selected", + ".unselected", + ], + [ + "._box.Box", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._line.Line", + "._marker.Marker", + "._meanline.Meanline", + "._selected.Selected", + "._stream.Stream", + "._unselected.Unselected", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_box.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_box.py new file mode 100644 index 0000000..7aa241e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_box.py @@ -0,0 +1,163 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Box(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.box" + _valid_props = {"fillcolor", "line", "visible", "width"} + + @property + def fillcolor(self): + """ + Sets the inner box plot fill color. + + The 'fillcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["fillcolor"] + + @fillcolor.setter + def fillcolor(self, val): + self["fillcolor"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.box.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.violin.box.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def visible(self): + """ + Determines if an miniature box plot is drawn inside the + violins. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the width of the inner box plots relative to the violins' + width. For example, with 1, the inner box plots are as wide as + the violins. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + fillcolor + Sets the inner box plot fill color. + line + :class:`plotly.graph_objects.violin.box.Line` instance + or dict with compatible properties + visible + Determines if an miniature box plot is drawn inside the + violins. + width + Sets the width of the inner box plots relative to the + violins' width. For example, with 1, the inner box + plots are as wide as the violins. + """ + + def __init__( + self, arg=None, fillcolor=None, line=None, visible=None, width=None, **kwargs + ): + """ + Construct a new Box object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.violin.Box` + fillcolor + Sets the inner box plot fill color. + line + :class:`plotly.graph_objects.violin.box.Line` instance + or dict with compatible properties + visible + Determines if an miniature box plot is drawn inside the + violins. + width + Sets the width of the inner box plots relative to the + violins' width. For example, with 1, the inner box + plots are as wide as the violins. + + Returns + ------- + Box + """ + super().__init__("box") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Box +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Box`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fillcolor", arg, fillcolor) + self._set_property("line", arg, line) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_hoverlabel.py new file mode 100644 index 0000000..b5bdfcd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.violin.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_legendgrouptitle.py new file mode 100644 index 0000000..2345d27 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.violin.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_line.py new file mode 100644 index 0000000..e4b50d6 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_line.py @@ -0,0 +1,103 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the color of line bounding the violin(s). + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the width (in px) of line bounding the violin(s). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of line bounding the violin(s). + width + Sets the width (in px) of line bounding the violin(s). + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.violin.Line` + color + Sets the color of line bounding the violin(s). + width + Sets the width (in px) of line bounding the violin(s). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_marker.py new file mode 100644 index 0000000..6389cae --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_marker.py @@ -0,0 +1,357 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.marker" + _valid_props = { + "angle", + "color", + "line", + "opacity", + "outliercolor", + "size", + "symbol", + } + + @property + def angle(self): + """ + Sets the marker angle in respect to `angleref`. + + The 'angle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["angle"] + + @angle.setter + def angle(self, val): + self["angle"] = val + + @property + def color(self): + """ + Sets the marker color. It accepts either a specific color or an + array of numbers that are mapped to the colorscale relative to + the max and min values of the array or relative to + `marker.cmin` and `marker.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.violin.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def opacity(self): + """ + Sets the marker opacity. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def outliercolor(self): + """ + Sets the color of the outlier sample points. + + The 'outliercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outliercolor"] + + @outliercolor.setter + def outliercolor(self, val): + self["outliercolor"] = val + + @property + def size(self): + """ + Sets the marker size (in px). + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def symbol(self): + """ + Sets the marker symbol type. Adding 100 is equivalent to + appending "-open" to a symbol name. Adding 200 is equivalent to + appending "-dot" to a symbol name. Adding 300 is equivalent to + appending "-open-dot" or "dot-open" to a symbol name. + + The 'symbol' property is an enumeration that may be specified as: + - One of the following enumeration values: + [0, '0', 'circle', 100, '100', 'circle-open', 200, '200', + 'circle-dot', 300, '300', 'circle-open-dot', 1, '1', + 'square', 101, '101', 'square-open', 201, '201', + 'square-dot', 301, '301', 'square-open-dot', 2, '2', + 'diamond', 102, '102', 'diamond-open', 202, '202', + 'diamond-dot', 302, '302', 'diamond-open-dot', 3, '3', + 'cross', 103, '103', 'cross-open', 203, '203', + 'cross-dot', 303, '303', 'cross-open-dot', 4, '4', 'x', + 104, '104', 'x-open', 204, '204', 'x-dot', 304, '304', + 'x-open-dot', 5, '5', 'triangle-up', 105, '105', + 'triangle-up-open', 205, '205', 'triangle-up-dot', 305, + '305', 'triangle-up-open-dot', 6, '6', 'triangle-down', + 106, '106', 'triangle-down-open', 206, '206', + 'triangle-down-dot', 306, '306', 'triangle-down-open-dot', + 7, '7', 'triangle-left', 107, '107', 'triangle-left-open', + 207, '207', 'triangle-left-dot', 307, '307', + 'triangle-left-open-dot', 8, '8', 'triangle-right', 108, + '108', 'triangle-right-open', 208, '208', + 'triangle-right-dot', 308, '308', + 'triangle-right-open-dot', 9, '9', 'triangle-ne', 109, + '109', 'triangle-ne-open', 209, '209', 'triangle-ne-dot', + 309, '309', 'triangle-ne-open-dot', 10, '10', + 'triangle-se', 110, '110', 'triangle-se-open', 210, '210', + 'triangle-se-dot', 310, '310', 'triangle-se-open-dot', 11, + '11', 'triangle-sw', 111, '111', 'triangle-sw-open', 211, + '211', 'triangle-sw-dot', 311, '311', + 'triangle-sw-open-dot', 12, '12', 'triangle-nw', 112, + '112', 'triangle-nw-open', 212, '212', 'triangle-nw-dot', + 312, '312', 'triangle-nw-open-dot', 13, '13', 'pentagon', + 113, '113', 'pentagon-open', 213, '213', 'pentagon-dot', + 313, '313', 'pentagon-open-dot', 14, '14', 'hexagon', 114, + '114', 'hexagon-open', 214, '214', 'hexagon-dot', 314, + '314', 'hexagon-open-dot', 15, '15', 'hexagon2', 115, + '115', 'hexagon2-open', 215, '215', 'hexagon2-dot', 315, + '315', 'hexagon2-open-dot', 16, '16', 'octagon', 116, + '116', 'octagon-open', 216, '216', 'octagon-dot', 316, + '316', 'octagon-open-dot', 17, '17', 'star', 117, '117', + 'star-open', 217, '217', 'star-dot', 317, '317', + 'star-open-dot', 18, '18', 'hexagram', 118, '118', + 'hexagram-open', 218, '218', 'hexagram-dot', 318, '318', + 'hexagram-open-dot', 19, '19', 'star-triangle-up', 119, + '119', 'star-triangle-up-open', 219, '219', + 'star-triangle-up-dot', 319, '319', + 'star-triangle-up-open-dot', 20, '20', + 'star-triangle-down', 120, '120', + 'star-triangle-down-open', 220, '220', + 'star-triangle-down-dot', 320, '320', + 'star-triangle-down-open-dot', 21, '21', 'star-square', + 121, '121', 'star-square-open', 221, '221', + 'star-square-dot', 321, '321', 'star-square-open-dot', 22, + '22', 'star-diamond', 122, '122', 'star-diamond-open', + 222, '222', 'star-diamond-dot', 322, '322', + 'star-diamond-open-dot', 23, '23', 'diamond-tall', 123, + '123', 'diamond-tall-open', 223, '223', + 'diamond-tall-dot', 323, '323', 'diamond-tall-open-dot', + 24, '24', 'diamond-wide', 124, '124', 'diamond-wide-open', + 224, '224', 'diamond-wide-dot', 324, '324', + 'diamond-wide-open-dot', 25, '25', 'hourglass', 125, + '125', 'hourglass-open', 26, '26', 'bowtie', 126, '126', + 'bowtie-open', 27, '27', 'circle-cross', 127, '127', + 'circle-cross-open', 28, '28', 'circle-x', 128, '128', + 'circle-x-open', 29, '29', 'square-cross', 129, '129', + 'square-cross-open', 30, '30', 'square-x', 130, '130', + 'square-x-open', 31, '31', 'diamond-cross', 131, '131', + 'diamond-cross-open', 32, '32', 'diamond-x', 132, '132', + 'diamond-x-open', 33, '33', 'cross-thin', 133, '133', + 'cross-thin-open', 34, '34', 'x-thin', 134, '134', + 'x-thin-open', 35, '35', 'asterisk', 135, '135', + 'asterisk-open', 36, '36', 'hash', 136, '136', + 'hash-open', 236, '236', 'hash-dot', 336, '336', + 'hash-open-dot', 37, '37', 'y-up', 137, '137', + 'y-up-open', 38, '38', 'y-down', 138, '138', + 'y-down-open', 39, '39', 'y-left', 139, '139', + 'y-left-open', 40, '40', 'y-right', 140, '140', + 'y-right-open', 41, '41', 'line-ew', 141, '141', + 'line-ew-open', 42, '42', 'line-ns', 142, '142', + 'line-ns-open', 43, '43', 'line-ne', 143, '143', + 'line-ne-open', 44, '44', 'line-nw', 144, '144', + 'line-nw-open', 45, '45', 'arrow-up', 145, '145', + 'arrow-up-open', 46, '46', 'arrow-down', 146, '146', + 'arrow-down-open', 47, '47', 'arrow-left', 147, '147', + 'arrow-left-open', 48, '48', 'arrow-right', 148, '148', + 'arrow-right-open', 49, '49', 'arrow-bar-up', 149, '149', + 'arrow-bar-up-open', 50, '50', 'arrow-bar-down', 150, + '150', 'arrow-bar-down-open', 51, '51', 'arrow-bar-left', + 151, '151', 'arrow-bar-left-open', 52, '52', + 'arrow-bar-right', 152, '152', 'arrow-bar-right-open', 53, + '53', 'arrow', 153, '153', 'arrow-open', 54, '54', + 'arrow-wide', 154, '154', 'arrow-wide-open'] + + Returns + ------- + Any + """ + return self["symbol"] + + @symbol.setter + def symbol(self, val): + self["symbol"] = val + + @property + def _prop_descriptions(self): + return """\ + angle + Sets the marker angle in respect to `angleref`. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + :class:`plotly.graph_objects.violin.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + """ + + def __init__( + self, + arg=None, + angle=None, + color=None, + line=None, + opacity=None, + outliercolor=None, + size=None, + symbol=None, + **kwargs, + ): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.violin.Marker` + angle + Sets the marker angle in respect to `angleref`. + color + Sets the marker color. It accepts either a specific + color or an array of numbers that are mapped to the + colorscale relative to the max and min values of the + array or relative to `marker.cmin` and `marker.cmax` if + set. + line + :class:`plotly.graph_objects.violin.marker.Line` + instance or dict with compatible properties + opacity + Sets the marker opacity. + outliercolor + Sets the color of the outlier sample points. + size + Sets the marker size (in px). + symbol + Sets the marker symbol type. Adding 100 is equivalent + to appending "-open" to a symbol name. Adding 200 is + equivalent to appending "-dot" to a symbol name. Adding + 300 is equivalent to appending "-open-dot" or "dot- + open" to a symbol name. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("angle", arg, angle) + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._set_property("opacity", arg, opacity) + self._set_property("outliercolor", arg, outliercolor) + self._set_property("size", arg, size) + self._set_property("symbol", arg, symbol) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_meanline.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_meanline.py new file mode 100644 index 0000000..4eecef2 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_meanline.py @@ -0,0 +1,138 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Meanline(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.meanline" + _valid_props = {"color", "visible", "width"} + + @property + def color(self): + """ + Sets the mean line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def visible(self): + """ + Determines if a line corresponding to the sample's mean is + shown inside the violins. If `box.visible` is turned on, the + mean line is drawn inside the inner box. Otherwise, the mean + line is drawn from one side of the violin to other. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def width(self): + """ + Sets the mean line width. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the mean line color. + visible + Determines if a line corresponding to the sample's mean + is shown inside the violins. If `box.visible` is turned + on, the mean line is drawn inside the inner box. + Otherwise, the mean line is drawn from one side of the + violin to other. + width + Sets the mean line width. + """ + + def __init__(self, arg=None, color=None, visible=None, width=None, **kwargs): + """ + Construct a new Meanline object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.Meanline` + color + Sets the mean line color. + visible + Determines if a line corresponding to the sample's mean + is shown inside the violins. If `box.visible` is turned + on, the mean line is drawn inside the inner box. + Otherwise, the mean line is drawn from one side of the + violin to other. + width + Sets the mean line width. + + Returns + ------- + Meanline + """ + super().__init__("meanline") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Meanline +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Meanline`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("visible", arg, visible) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_selected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_selected.py new file mode 100644 index 0000000..ec18b8f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_selected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Selected(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.selected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.selected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.violin.selected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.violin.selected.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Selected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.Selected` + marker + :class:`plotly.graph_objects.violin.selected.Marker` + instance or dict with compatible properties + + Returns + ------- + Selected + """ + super().__init__("selected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Selected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Selected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_stream.py new file mode 100644 index 0000000..959e455 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.violin.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_unselected.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_unselected.py new file mode 100644 index 0000000..9e13dda --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/_unselected.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Unselected(_BaseTraceHierarchyType): + _parent_path_str = "violin" + _path_str = "violin.unselected" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.violin.unselected.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.violin.unselected.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.violin.unselected.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Unselected object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.Unselected` + marker + :class:`plotly.graph_objects.violin.unselected.Marker` + instance or dict with compatible properties + + Returns + ------- + Unselected + """ + super().__init__("unselected") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.Unselected +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.Unselected`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/_line.py new file mode 100644 index 0000000..aab887d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/box/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "violin.box" + _path_str = "violin.box.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the inner box plot bounding line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the inner box plot bounding line width. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the inner box plot bounding line color. + width + Sets the inner box plot bounding line width. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.box.Line` + color + Sets the inner box plot bounding line color. + width + Sets the inner box plot bounding line width. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.box.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.box.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/_font.py new file mode 100644 index 0000000..190b7e0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "violin.hoverlabel" + _path_str = "violin.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/_font.py new file mode 100644 index 0000000..d9bd7ad --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "violin.legendgrouptitle" + _path_str = "violin.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/_line.py new file mode 100644 index 0000000..b46ec94 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/marker/_line.py @@ -0,0 +1,181 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "violin.marker" + _path_str = "violin.marker.line" + _valid_props = {"color", "outliercolor", "outlierwidth", "width"} + + @property + def color(self): + """ + Sets the marker.line color. It accepts either a specific color + or an array of numbers that are mapped to the colorscale + relative to the max and min values of the array or relative to + `marker.line.cmin` and `marker.line.cmax` if set. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def outliercolor(self): + """ + Sets the border line color of the outlier sample points. + Defaults to marker.color + + The 'outliercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outliercolor"] + + @outliercolor.setter + def outliercolor(self, val): + self["outliercolor"] = val + + @property + def outlierwidth(self): + """ + Sets the border line width (in px) of the outlier sample + points. + + The 'outlierwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlierwidth"] + + @outlierwidth.setter + def outlierwidth(self, val): + self["outlierwidth"] = val + + @property + def width(self): + """ + Sets the width (in px) of the lines bounding the marker points. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + """ + + def __init__( + self, + arg=None, + color=None, + outliercolor=None, + outlierwidth=None, + width=None, + **kwargs, + ): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.marker.Line` + color + Sets the marker.line color. It accepts either a + specific color or an array of numbers that are mapped + to the colorscale relative to the max and min values of + the array or relative to `marker.line.cmin` and + `marker.line.cmax` if set. + outliercolor + Sets the border line color of the outlier sample + points. Defaults to marker.color + outlierwidth + Sets the border line width (in px) of the outlier + sample points. + width + Sets the width (in px) of the lines bounding the marker + points. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("outliercolor", arg, outliercolor) + self._set_property("outlierwidth", arg, outlierwidth) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/_marker.py new file mode 100644 index 0000000..79d5ec0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/selected/_marker.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "violin.selected" + _path_str = "violin.selected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of selected points. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of selected points. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of selected points. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.selected.Marker` + color + Sets the marker color of selected points. + opacity + Sets the marker opacity of selected points. + size + Sets the marker size of selected points. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.selected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.selected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/__init__.py new file mode 100644 index 0000000..b4ba7bf --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._marker.Marker"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/_marker.py new file mode 100644 index 0000000..657f722 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/violin/unselected/_marker.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "violin.unselected" + _path_str = "violin.unselected.marker" + _valid_props = {"color", "opacity", "size"} + + @property + def color(self): + """ + Sets the marker color of unselected points, applied only when a + selection exists. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def opacity(self): + """ + Sets the marker opacity of unselected points, applied only when + a selection exists. + + The 'opacity' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["opacity"] + + @opacity.setter + def opacity(self, val): + self["opacity"] = val + + @property + def size(self): + """ + Sets the marker size of unselected points, applied only when a + selection exists. + + The 'size' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + """ + + def __init__(self, arg=None, color=None, opacity=None, size=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.violin.unselected.Marker` + color + Sets the marker color of unselected points, applied + only when a selection exists. + opacity + Sets the marker opacity of unselected points, applied + only when a selection exists. + size + Sets the marker size of unselected points, applied only + when a selection exists. + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.violin.unselected.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.violin.unselected.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("opacity", arg, opacity) + self._set_property("size", arg, size) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/__init__.py new file mode 100644 index 0000000..27f503c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/__init__.py @@ -0,0 +1,40 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._caps import Caps + from ._colorbar import ColorBar + from ._contour import Contour + from ._hoverlabel import Hoverlabel + from ._legendgrouptitle import Legendgrouptitle + from ._lighting import Lighting + from ._lightposition import Lightposition + from ._slices import Slices + from ._spaceframe import Spaceframe + from ._stream import Stream + from ._surface import Surface + from . import caps + from . import colorbar + from . import hoverlabel + from . import legendgrouptitle + from . import slices +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".caps", ".colorbar", ".hoverlabel", ".legendgrouptitle", ".slices"], + [ + "._caps.Caps", + "._colorbar.ColorBar", + "._contour.Contour", + "._hoverlabel.Hoverlabel", + "._legendgrouptitle.Legendgrouptitle", + "._lighting.Lighting", + "._lightposition.Lightposition", + "._slices.Slices", + "._spaceframe.Spaceframe", + "._stream.Stream", + "._surface.Surface", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_caps.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_caps.py new file mode 100644 index 0000000..20d4443 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_caps.py @@ -0,0 +1,131 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Caps(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.caps" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.caps.X` + - A dict of string/value properties that will be passed + to the X constructor + + Returns + ------- + plotly.graph_objs.volume.caps.X + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.caps.Y` + - A dict of string/value properties that will be passed + to the Y constructor + + Returns + ------- + plotly.graph_objs.volume.caps.Y + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.caps.Z` + - A dict of string/value properties that will be passed + to the Z constructor + + Returns + ------- + plotly.graph_objs.volume.caps.Z + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + :class:`plotly.graph_objects.volume.caps.X` instance or + dict with compatible properties + y + :class:`plotly.graph_objects.volume.caps.Y` instance or + dict with compatible properties + z + :class:`plotly.graph_objects.volume.caps.Z` instance or + dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Caps object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.Caps` + x + :class:`plotly.graph_objects.volume.caps.X` instance or + dict with compatible properties + y + :class:`plotly.graph_objects.volume.caps.Y` instance or + dict with compatible properties + z + :class:`plotly.graph_objects.volume.caps.Z` instance or + dict with compatible properties + + Returns + ------- + Caps + """ + super().__init__("caps") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Caps +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Caps`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_colorbar.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_colorbar.py new file mode 100644 index 0000000..9384323 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_colorbar.py @@ -0,0 +1,1722 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class ColorBar(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.colorbar" + _valid_props = { + "bgcolor", + "bordercolor", + "borderwidth", + "dtick", + "exponentformat", + "labelalias", + "len", + "lenmode", + "minexponent", + "nticks", + "orientation", + "outlinecolor", + "outlinewidth", + "separatethousands", + "showexponent", + "showticklabels", + "showtickprefix", + "showticksuffix", + "thickness", + "thicknessmode", + "tick0", + "tickangle", + "tickcolor", + "tickfont", + "tickformat", + "tickformatstopdefaults", + "tickformatstops", + "ticklabeloverflow", + "ticklabelposition", + "ticklabelstep", + "ticklen", + "tickmode", + "tickprefix", + "ticks", + "ticksuffix", + "ticktext", + "ticktextsrc", + "tickvals", + "tickvalssrc", + "tickwidth", + "title", + "x", + "xanchor", + "xpad", + "xref", + "y", + "yanchor", + "ypad", + "yref", + } + + @property + def bgcolor(self): + """ + Sets the color of padded area. + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bordercolor(self): + """ + Sets the axis line color. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def borderwidth(self): + """ + Sets the width (in px) or the border enclosing this color bar. + + The 'borderwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["borderwidth"] + + @borderwidth.setter + def borderwidth(self, val): + self["borderwidth"] = val + + @property + def dtick(self): + """ + Sets the step in-between ticks on this axis. Use with `tick0`. + Must be a positive number, or special strings available to + "log" and "date" axes. If the axis `type` is "log", then ticks + are set every 10^(n*dtick) where n is the tick number. For + example, to set a tick mark at 1, 10, 100, 1000, ... set dtick + to 1. To set tick marks at 1, 100, 10000, ... set dtick to 2. + To set tick marks at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special values; + "L", where `f` is a positive number, gives ticks linearly + spaced in value (but not position). For example `tick0` = 0.1, + `dtick` = "L0.5" will put ticks at 0.1, 0.6, 1.1, 1.6 etc. To + show powers of 10 plus small digits between, use "D1" (all + digits) or "D2" (only 2 and 5). `tick0` is ignored for "D1" and + "D2". If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval between + ticks to one day, set `dtick` to 86400000.0. "date" also has + special values "M" gives ticks spaced by a number of months. + `n` must be a positive integer. To set ticks on the 15th of + every third month, set `tick0` to "2000-01-15" and `dtick` to + "M3". To set ticks every 4 years, set `dtick` to "M48" + + The 'dtick' property accepts values of any type + + Returns + ------- + Any + """ + return self["dtick"] + + @dtick.setter + def dtick(self, val): + self["dtick"] = val + + @property + def exponentformat(self): + """ + Determines a formatting rule for the tick exponents. For + example, consider the number 1,000,000,000. If "none", it + appears as 1,000,000,000. If "e", 1e+9. If "E", 1E+9. If + "power", 1x10^9 (with 9 in a super script). If "SI", 1G. If + "B", 1B. + + The 'exponentformat' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['none', 'e', 'E', 'power', 'SI', 'B'] + + Returns + ------- + Any + """ + return self["exponentformat"] + + @exponentformat.setter + def exponentformat(self, val): + self["exponentformat"] = val + + @property + def labelalias(self): + """ + Replacement text for specific tick or hover labels. For example + using {US: 'USA', CA: 'Canada'} changes US to USA and CA to + Canada. The labels we would have shown must match the keys + exactly, after adding any tickprefix or ticksuffix. For + negative numbers the minus sign symbol used (U+2212) is wider + than the regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis type, and + both keys (if needed) and values (if desired) can include html- + like tags or MathJax. + + The 'labelalias' property accepts values of any type + + Returns + ------- + Any + """ + return self["labelalias"] + + @labelalias.setter + def labelalias(self, val): + self["labelalias"] = val + + @property + def len(self): + """ + Sets the length of the color bar This measure excludes the + padding of both ends. That is, the color bar length is this + length minus the padding on both ends. + + The 'len' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["len"] + + @len.setter + def len(self, val): + self["len"] = val + + @property + def lenmode(self): + """ + Determines whether this color bar's length (i.e. the measure in + the color variation direction) is set in units of plot + "fraction" or in *pixels. Use `len` to set the value. + + The 'lenmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["lenmode"] + + @lenmode.setter + def lenmode(self, val): + self["lenmode"] = val + + @property + def minexponent(self): + """ + Hide SI prefix for 10^n if |n| is below this number. This only + has an effect when `tickformat` is "SI" or "B". + + The 'minexponent' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["minexponent"] + + @minexponent.setter + def minexponent(self, val): + self["minexponent"] = val + + @property + def nticks(self): + """ + Specifies the maximum number of ticks for the particular axis. + The actual number of ticks will be chosen automatically to be + less than or equal to `nticks`. Has an effect only if + `tickmode` is set to "auto". + + The 'nticks' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [0, 9223372036854775807] + + Returns + ------- + int + """ + return self["nticks"] + + @nticks.setter + def nticks(self, val): + self["nticks"] = val + + @property + def orientation(self): + """ + Sets the orientation of the colorbar. + + The 'orientation' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['h', 'v'] + + Returns + ------- + Any + """ + return self["orientation"] + + @orientation.setter + def orientation(self, val): + self["orientation"] = val + + @property + def outlinecolor(self): + """ + Sets the axis line color. + + The 'outlinecolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["outlinecolor"] + + @outlinecolor.setter + def outlinecolor(self, val): + self["outlinecolor"] = val + + @property + def outlinewidth(self): + """ + Sets the width (in px) of the axis line. + + The 'outlinewidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["outlinewidth"] + + @outlinewidth.setter + def outlinewidth(self, val): + self["outlinewidth"] = val + + @property + def separatethousands(self): + """ + If "true", even 4-digit integers are separated + + The 'separatethousands' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["separatethousands"] + + @separatethousands.setter + def separatethousands(self, val): + self["separatethousands"] = val + + @property + def showexponent(self): + """ + If "all", all exponents are shown besides their significands. + If "first", only the exponent of the first tick is shown. If + "last", only the exponent of the last tick is shown. If "none", + no exponents appear. + + The 'showexponent' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showexponent"] + + @showexponent.setter + def showexponent(self, val): + self["showexponent"] = val + + @property + def showticklabels(self): + """ + Determines whether or not the tick labels are drawn. + + The 'showticklabels' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["showticklabels"] + + @showticklabels.setter + def showticklabels(self, val): + self["showticklabels"] = val + + @property + def showtickprefix(self): + """ + If "all", all tick labels are displayed with a prefix. If + "first", only the first tick is displayed with a prefix. If + "last", only the last tick is displayed with a suffix. If + "none", tick prefixes are hidden. + + The 'showtickprefix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showtickprefix"] + + @showtickprefix.setter + def showtickprefix(self, val): + self["showtickprefix"] = val + + @property + def showticksuffix(self): + """ + Same as `showtickprefix` but for tick suffixes. + + The 'showticksuffix' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['all', 'first', 'last', 'none'] + + Returns + ------- + Any + """ + return self["showticksuffix"] + + @showticksuffix.setter + def showticksuffix(self, val): + self["showticksuffix"] = val + + @property + def thickness(self): + """ + Sets the thickness of the color bar This measure excludes the + size of the padding, ticks and labels. + + The 'thickness' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["thickness"] + + @thickness.setter + def thickness(self, val): + self["thickness"] = val + + @property + def thicknessmode(self): + """ + Determines whether this color bar's thickness (i.e. the measure + in the constant color direction) is set in units of plot + "fraction" or in "pixels". Use `thickness` to set the value. + + The 'thicknessmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['fraction', 'pixels'] + + Returns + ------- + Any + """ + return self["thicknessmode"] + + @thicknessmode.setter + def thicknessmode(self, val): + self["thicknessmode"] = val + + @property + def tick0(self): + """ + Sets the placement of the first tick on this axis. Use with + `dtick`. If the axis `type` is "log", then you must take the + log of your starting tick (e.g. to set the starting tick to + 100, set the `tick0` to 2) except when `dtick`=*L* (see + `dtick` for more info). If the axis `type` is "date", it should + be a date string, like date data. If the axis `type` is + "category", it should be a number, using the scale where each + category is assigned a serial number from zero in the order it + appears. + + The 'tick0' property accepts values of any type + + Returns + ------- + Any + """ + return self["tick0"] + + @tick0.setter + def tick0(self, val): + self["tick0"] = val + + @property + def tickangle(self): + """ + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the tick + labels vertically. + + The 'tickangle' property is a angle (in degrees) that may be + specified as a number between -180 and 180. + Numeric values outside this range are converted to the equivalent value + (e.g. 270 is converted to -90). + + Returns + ------- + int|float + """ + return self["tickangle"] + + @tickangle.setter + def tickangle(self, val): + self["tickangle"] = val + + @property + def tickcolor(self): + """ + Sets the tick color. + + The 'tickcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["tickcolor"] + + @tickcolor.setter + def tickcolor(self, val): + self["tickcolor"] = val + + @property + def tickfont(self): + """ + Sets the color bar's tick label font + + The 'tickfont' property is an instance of Tickfont + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.colorbar.Tickfont` + - A dict of string/value properties that will be passed + to the Tickfont constructor + + Returns + ------- + plotly.graph_objs.volume.colorbar.Tickfont + """ + return self["tickfont"] + + @tickfont.setter + def tickfont(self, val): + self["tickfont"] = val + + @property + def tickformat(self): + """ + Sets the tick label formatting rule using d3 formatting mini- + languages which are very similar to those in Python. For + numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. And for + dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to d3's date + formatter: "%h" for half of the year as a decimal number as + well as "%{n}f" for fractional seconds with n digits. For + example, *2016-10-13 09:15:23.456* with tickformat + "%H~%M~%S.%2f" would display "09~15~23.46" + + The 'tickformat' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickformat"] + + @tickformat.setter + def tickformat(self, val): + self["tickformat"] = val + + @property + def tickformatstops(self): + """ + The 'tickformatstops' property is a tuple of instances of + Tickformatstop that may be specified as: + - A list or tuple of instances of plotly.graph_objs.volume.colorbar.Tickformatstop + - A list or tuple of dicts of string/value properties that + will be passed to the Tickformatstop constructor + + Returns + ------- + tuple[plotly.graph_objs.volume.colorbar.Tickformatstop] + """ + return self["tickformatstops"] + + @tickformatstops.setter + def tickformatstops(self, val): + self["tickformatstops"] = val + + @property + def tickformatstopdefaults(self): + """ + When used in a template (as + layout.template.data.volume.colorbar.tickformatstopdefaults), + sets the default property values to use for elements of + volume.colorbar.tickformatstops + + The 'tickformatstopdefaults' property is an instance of Tickformatstop + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.colorbar.Tickformatstop` + - A dict of string/value properties that will be passed + to the Tickformatstop constructor + + Returns + ------- + plotly.graph_objs.volume.colorbar.Tickformatstop + """ + return self["tickformatstopdefaults"] + + @tickformatstopdefaults.setter + def tickformatstopdefaults(self, val): + self["tickformatstopdefaults"] = val + + @property + def ticklabeloverflow(self): + """ + Determines how we handle tick labels that would overflow either + the graph div or the domain of the axis. The default value for + inside tick labels is *hide past domain*. In other cases the + default is *hide past div*. + + The 'ticklabeloverflow' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['allow', 'hide past div', 'hide past domain'] + + Returns + ------- + Any + """ + return self["ticklabeloverflow"] + + @ticklabeloverflow.setter + def ticklabeloverflow(self, val): + self["ticklabeloverflow"] = val + + @property + def ticklabelposition(self): + """ + Determines where tick labels are drawn relative to the ticks. + Left and right options are used when `orientation` is "h", top + and bottom when `orientation` is "v". + + The 'ticklabelposition' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', 'outside top', 'inside top', + 'outside left', 'inside left', 'outside right', 'inside + right', 'outside bottom', 'inside bottom'] + + Returns + ------- + Any + """ + return self["ticklabelposition"] + + @ticklabelposition.setter + def ticklabelposition(self, val): + self["ticklabelposition"] = val + + @property + def ticklabelstep(self): + """ + Sets the spacing between tick labels as compared to the spacing + between ticks. A value of 1 (default) means each tick gets a + label. A value of 2 means shows every 2nd label. A larger value + n means only every nth tick is labeled. `tick0` determines + which labels are shown. Not implemented for axes with `type` + "log" or "multicategory", or when `tickmode` is "array". + + The 'ticklabelstep' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["ticklabelstep"] + + @ticklabelstep.setter + def ticklabelstep(self, val): + self["ticklabelstep"] = val + + @property + def ticklen(self): + """ + Sets the tick length (in px). + + The 'ticklen' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ticklen"] + + @ticklen.setter + def ticklen(self, val): + self["ticklen"] = val + + @property + def tickmode(self): + """ + Sets the tick mode for this axis. If "auto", the number of + ticks is set via `nticks`. If "linear", the placement of the + ticks is determined by a starting position `tick0` and a tick + step `dtick` ("linear" is the default value if `tick0` and + `dtick` are provided). If "array", the placement of the ticks + is set via `tickvals` and the tick text is `ticktext`. ("array" + is the default value if `tickvals` is provided). + + The 'tickmode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['auto', 'linear', 'array'] + + Returns + ------- + Any + """ + return self["tickmode"] + + @tickmode.setter + def tickmode(self, val): + self["tickmode"] = val + + @property + def tickprefix(self): + """ + Sets a tick label prefix. + + The 'tickprefix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["tickprefix"] + + @tickprefix.setter + def tickprefix(self, val): + self["tickprefix"] = val + + @property + def ticks(self): + """ + Determines whether ticks are drawn or not. If "", this axis' + ticks are not drawn. If "outside" ("inside"), this axis' are + drawn outside (inside) the axis lines. + + The 'ticks' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['outside', 'inside', ''] + + Returns + ------- + Any + """ + return self["ticks"] + + @ticks.setter + def ticks(self, val): + self["ticks"] = val + + @property + def ticksuffix(self): + """ + Sets a tick label suffix. + + The 'ticksuffix' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["ticksuffix"] + + @ticksuffix.setter + def ticksuffix(self, val): + self["ticksuffix"] = val + + @property + def ticktext(self): + """ + Sets the text displayed at the ticks position via `tickvals`. + Only has an effect if `tickmode` is set to "array". Used with + `tickvals`. + + The 'ticktext' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["ticktext"] + + @ticktext.setter + def ticktext(self, val): + self["ticktext"] = val + + @property + def ticktextsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `ticktext`. + + The 'ticktextsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["ticktextsrc"] + + @ticktextsrc.setter + def ticktextsrc(self, val): + self["ticktextsrc"] = val + + @property + def tickvals(self): + """ + Sets the values at which ticks on this axis appear. Only has an + effect if `tickmode` is set to "array". Used with `ticktext`. + + The 'tickvals' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["tickvals"] + + @tickvals.setter + def tickvals(self, val): + self["tickvals"] = val + + @property + def tickvalssrc(self): + """ + Sets the source reference on Chart Studio Cloud for `tickvals`. + + The 'tickvalssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["tickvalssrc"] + + @tickvalssrc.setter + def tickvalssrc(self, val): + self["tickvalssrc"] = val + + @property + def tickwidth(self): + """ + Sets the tick width (in px). + + The 'tickwidth' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["tickwidth"] + + @tickwidth.setter + def tickwidth(self, val): + self["tickwidth"] = val + + @property + def title(self): + """ + The 'title' property is an instance of Title + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.colorbar.Title` + - A dict of string/value properties that will be passed + to the Title constructor + + Returns + ------- + plotly.graph_objs.volume.colorbar.Title + """ + return self["title"] + + @title.setter + def title(self, val): + self["title"] = val + + @property + def x(self): + """ + Sets the x position with respect to `xref` of the color bar (in + plot fraction). When `xref` is "paper", defaults to 1.02 when + `orientation` is "v" and 0.5 when `orientation` is "h". When + `xref` is "container", defaults to 1 when `orientation` is "v" + and 0.5 when `orientation` is "h". Must be between 0 and 1 if + `xref` is "container" and between "-2" and 3 if `xref` is + "paper". + + The 'x' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def xanchor(self): + """ + Sets this color bar's horizontal position anchor. This anchor + binds the `x` position to the "left", "center" or "right" of + the color bar. Defaults to "left" when `orientation` is "v" and + "center" when `orientation` is "h". + + The 'xanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'center', 'right'] + + Returns + ------- + Any + """ + return self["xanchor"] + + @xanchor.setter + def xanchor(self, val): + self["xanchor"] = val + + @property + def xpad(self): + """ + Sets the amount of padding (in px) along the x direction. + + The 'xpad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["xpad"] + + @xpad.setter + def xpad(self, val): + self["xpad"] = val + + @property + def xref(self): + """ + Sets the container `x` refers to. "container" spans the entire + `width` of the plot. "paper" refers to the width of the + plotting area only. + + The 'xref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["xref"] + + @xref.setter + def xref(self, val): + self["xref"] = val + + @property + def y(self): + """ + Sets the y position with respect to `yref` of the color bar (in + plot fraction). When `yref` is "paper", defaults to 0.5 when + `orientation` is "v" and 1.02 when `orientation` is "h". When + `yref` is "container", defaults to 0.5 when `orientation` is + "v" and 1 when `orientation` is "h". Must be between 0 and 1 if + `yref` is "container" and between "-2" and 3 if `yref` is + "paper". + + The 'y' property is a number and may be specified as: + - An int or float + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def yanchor(self): + """ + Sets this color bar's vertical position anchor This anchor + binds the `y` position to the "top", "middle" or "bottom" of + the color bar. Defaults to "middle" when `orientation` is "v" + and "bottom" when `orientation` is "h". + + The 'yanchor' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['top', 'middle', 'bottom'] + + Returns + ------- + Any + """ + return self["yanchor"] + + @yanchor.setter + def yanchor(self, val): + self["yanchor"] = val + + @property + def ypad(self): + """ + Sets the amount of padding (in px) along the y direction. + + The 'ypad' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["ypad"] + + @ypad.setter + def ypad(self, val): + self["ypad"] = val + + @property + def yref(self): + """ + Sets the container `y` refers to. "container" spans the entire + `height` of the plot. "paper" refers to the height of the + plotting area only. + + The 'yref' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['container', 'paper'] + + Returns + ------- + Any + """ + return self["yref"] + + @yref.setter + def yref(self, val): + self["yref"] = val + + @property + def _prop_descriptions(self): + return """\ + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.volume.colorbar + .Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.volume + .colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + volume.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.volume.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + """ + + def __init__( + self, + arg=None, + bgcolor=None, + bordercolor=None, + borderwidth=None, + dtick=None, + exponentformat=None, + labelalias=None, + len=None, + lenmode=None, + minexponent=None, + nticks=None, + orientation=None, + outlinecolor=None, + outlinewidth=None, + separatethousands=None, + showexponent=None, + showticklabels=None, + showtickprefix=None, + showticksuffix=None, + thickness=None, + thicknessmode=None, + tick0=None, + tickangle=None, + tickcolor=None, + tickfont=None, + tickformat=None, + tickformatstops=None, + tickformatstopdefaults=None, + ticklabeloverflow=None, + ticklabelposition=None, + ticklabelstep=None, + ticklen=None, + tickmode=None, + tickprefix=None, + ticks=None, + ticksuffix=None, + ticktext=None, + ticktextsrc=None, + tickvals=None, + tickvalssrc=None, + tickwidth=None, + title=None, + x=None, + xanchor=None, + xpad=None, + xref=None, + y=None, + yanchor=None, + ypad=None, + yref=None, + **kwargs, + ): + """ + Construct a new ColorBar object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.ColorBar` + bgcolor + Sets the color of padded area. + bordercolor + Sets the axis line color. + borderwidth + Sets the width (in px) or the border enclosing this + color bar. + dtick + Sets the step in-between ticks on this axis. Use with + `tick0`. Must be a positive number, or special strings + available to "log" and "date" axes. If the axis `type` + is "log", then ticks are set every 10^(n*dtick) where n + is the tick number. For example, to set a tick mark at + 1, 10, 100, 1000, ... set dtick to 1. To set tick marks + at 1, 100, 10000, ... set dtick to 2. To set tick marks + at 1, 5, 25, 125, 625, 3125, ... set dtick to + log_10(5), or 0.69897000433. "log" has several special + values; "L", where `f` is a positive number, gives + ticks linearly spaced in value (but not position). For + example `tick0` = 0.1, `dtick` = "L0.5" will put ticks + at 0.1, 0.6, 1.1, 1.6 etc. To show powers of 10 plus + small digits between, use "D1" (all digits) or "D2" + (only 2 and 5). `tick0` is ignored for "D1" and "D2". + If the axis `type` is "date", then you must convert the + time to milliseconds. For example, to set the interval + between ticks to one day, set `dtick` to 86400000.0. + "date" also has special values "M" gives ticks + spaced by a number of months. `n` must be a positive + integer. To set ticks on the 15th of every third month, + set `tick0` to "2000-01-15" and `dtick` to "M3". To set + ticks every 4 years, set `dtick` to "M48" + exponentformat + Determines a formatting rule for the tick exponents. + For example, consider the number 1,000,000,000. If + "none", it appears as 1,000,000,000. If "e", 1e+9. If + "E", 1E+9. If "power", 1x10^9 (with 9 in a super + script). If "SI", 1G. If "B", 1B. + labelalias + Replacement text for specific tick or hover labels. For + example using {US: 'USA', CA: 'Canada'} changes US to + USA and CA to Canada. The labels we would have shown + must match the keys exactly, after adding any + tickprefix or ticksuffix. For negative numbers the + minus sign symbol used (U+2212) is wider than the + regular ascii dash. That means you need to use −1 + instead of -1. labelalias can be used with any axis + type, and both keys (if needed) and values (if desired) + can include html-like tags or MathJax. + len + Sets the length of the color bar This measure excludes + the padding of both ends. That is, the color bar length + is this length minus the padding on both ends. + lenmode + Determines whether this color bar's length (i.e. the + measure in the color variation direction) is set in + units of plot "fraction" or in *pixels. Use `len` to + set the value. + minexponent + Hide SI prefix for 10^n if |n| is below this number. + This only has an effect when `tickformat` is "SI" or + "B". + nticks + Specifies the maximum number of ticks for the + particular axis. The actual number of ticks will be + chosen automatically to be less than or equal to + `nticks`. Has an effect only if `tickmode` is set to + "auto". + orientation + Sets the orientation of the colorbar. + outlinecolor + Sets the axis line color. + outlinewidth + Sets the width (in px) of the axis line. + separatethousands + If "true", even 4-digit integers are separated + showexponent + If "all", all exponents are shown besides their + significands. If "first", only the exponent of the + first tick is shown. If "last", only the exponent of + the last tick is shown. If "none", no exponents appear. + showticklabels + Determines whether or not the tick labels are drawn. + showtickprefix + If "all", all tick labels are displayed with a prefix. + If "first", only the first tick is displayed with a + prefix. If "last", only the last tick is displayed with + a suffix. If "none", tick prefixes are hidden. + showticksuffix + Same as `showtickprefix` but for tick suffixes. + thickness + Sets the thickness of the color bar This measure + excludes the size of the padding, ticks and labels. + thicknessmode + Determines whether this color bar's thickness (i.e. the + measure in the constant color direction) is set in + units of plot "fraction" or in "pixels". Use + `thickness` to set the value. + tick0 + Sets the placement of the first tick on this axis. Use + with `dtick`. If the axis `type` is "log", then you + must take the log of your starting tick (e.g. to set + the starting tick to 100, set the `tick0` to 2) except + when `dtick`=*L* (see `dtick` for more info). If the + axis `type` is "date", it should be a date string, like + date data. If the axis `type` is "category", it should + be a number, using the scale where each category is + assigned a serial number from zero in the order it + appears. + tickangle + Sets the angle of the tick labels with respect to the + horizontal. For example, a `tickangle` of -90 draws the + tick labels vertically. + tickcolor + Sets the tick color. + tickfont + Sets the color bar's tick label font + tickformat + Sets the tick label formatting rule using d3 formatting + mini-languages which are very similar to those in + Python. For numbers, see: + https://github.com/d3/d3-format/tree/v1.4.5#d3-format. + And for dates see: https://github.com/d3/d3-time- + format/tree/v2.2.3#locale_format. We add two items to + d3's date formatter: "%h" for half of the year as a + decimal number as well as "%{n}f" for fractional + seconds with n digits. For example, *2016-10-13 + 09:15:23.456* with tickformat "%H~%M~%S.%2f" would + display "09~15~23.46" + tickformatstops + A tuple of :class:`plotly.graph_objects.volume.colorbar + .Tickformatstop` instances or dicts with compatible + properties + tickformatstopdefaults + When used in a template (as layout.template.data.volume + .colorbar.tickformatstopdefaults), sets the default + property values to use for elements of + volume.colorbar.tickformatstops + ticklabeloverflow + Determines how we handle tick labels that would + overflow either the graph div or the domain of the + axis. The default value for inside tick labels is *hide + past domain*. In other cases the default is *hide past + div*. + ticklabelposition + Determines where tick labels are drawn relative to the + ticks. Left and right options are used when + `orientation` is "h", top and bottom when `orientation` + is "v". + ticklabelstep + Sets the spacing between tick labels as compared to the + spacing between ticks. A value of 1 (default) means + each tick gets a label. A value of 2 means shows every + 2nd label. A larger value n means only every nth tick + is labeled. `tick0` determines which labels are shown. + Not implemented for axes with `type` "log" or + "multicategory", or when `tickmode` is "array". + ticklen + Sets the tick length (in px). + tickmode + Sets the tick mode for this axis. If "auto", the number + of ticks is set via `nticks`. If "linear", the + placement of the ticks is determined by a starting + position `tick0` and a tick step `dtick` ("linear" is + the default value if `tick0` and `dtick` are provided). + If "array", the placement of the ticks is set via + `tickvals` and the tick text is `ticktext`. ("array" is + the default value if `tickvals` is provided). + tickprefix + Sets a tick label prefix. + ticks + Determines whether ticks are drawn or not. If "", this + axis' ticks are not drawn. If "outside" ("inside"), + this axis' are drawn outside (inside) the axis lines. + ticksuffix + Sets a tick label suffix. + ticktext + Sets the text displayed at the ticks position via + `tickvals`. Only has an effect if `tickmode` is set to + "array". Used with `tickvals`. + ticktextsrc + Sets the source reference on Chart Studio Cloud for + `ticktext`. + tickvals + Sets the values at which ticks on this axis appear. + Only has an effect if `tickmode` is set to "array". + Used with `ticktext`. + tickvalssrc + Sets the source reference on Chart Studio Cloud for + `tickvals`. + tickwidth + Sets the tick width (in px). + title + :class:`plotly.graph_objects.volume.colorbar.Title` + instance or dict with compatible properties + x + Sets the x position with respect to `xref` of the color + bar (in plot fraction). When `xref` is "paper", + defaults to 1.02 when `orientation` is "v" and 0.5 when + `orientation` is "h". When `xref` is "container", + defaults to 1 when `orientation` is "v" and 0.5 when + `orientation` is "h". Must be between 0 and 1 if `xref` + is "container" and between "-2" and 3 if `xref` is + "paper". + xanchor + Sets this color bar's horizontal position anchor. This + anchor binds the `x` position to the "left", "center" + or "right" of the color bar. Defaults to "left" when + `orientation` is "v" and "center" when `orientation` is + "h". + xpad + Sets the amount of padding (in px) along the x + direction. + xref + Sets the container `x` refers to. "container" spans the + entire `width` of the plot. "paper" refers to the width + of the plotting area only. + y + Sets the y position with respect to `yref` of the color + bar (in plot fraction). When `yref` is "paper", + defaults to 0.5 when `orientation` is "v" and 1.02 when + `orientation` is "h". When `yref` is "container", + defaults to 0.5 when `orientation` is "v" and 1 when + `orientation` is "h". Must be between 0 and 1 if `yref` + is "container" and between "-2" and 3 if `yref` is + "paper". + yanchor + Sets this color bar's vertical position anchor This + anchor binds the `y` position to the "top", "middle" or + "bottom" of the color bar. Defaults to "middle" when + `orientation` is "v" and "bottom" when `orientation` is + "h". + ypad + Sets the amount of padding (in px) along the y + direction. + yref + Sets the container `y` refers to. "container" spans the + entire `height` of the plot. "paper" refers to the + height of the plotting area only. + + Returns + ------- + ColorBar + """ + super().__init__("colorbar") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.ColorBar +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.ColorBar`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("borderwidth", arg, borderwidth) + self._set_property("dtick", arg, dtick) + self._set_property("exponentformat", arg, exponentformat) + self._set_property("labelalias", arg, labelalias) + self._set_property("len", arg, len) + self._set_property("lenmode", arg, lenmode) + self._set_property("minexponent", arg, minexponent) + self._set_property("nticks", arg, nticks) + self._set_property("orientation", arg, orientation) + self._set_property("outlinecolor", arg, outlinecolor) + self._set_property("outlinewidth", arg, outlinewidth) + self._set_property("separatethousands", arg, separatethousands) + self._set_property("showexponent", arg, showexponent) + self._set_property("showticklabels", arg, showticklabels) + self._set_property("showtickprefix", arg, showtickprefix) + self._set_property("showticksuffix", arg, showticksuffix) + self._set_property("thickness", arg, thickness) + self._set_property("thicknessmode", arg, thicknessmode) + self._set_property("tick0", arg, tick0) + self._set_property("tickangle", arg, tickangle) + self._set_property("tickcolor", arg, tickcolor) + self._set_property("tickfont", arg, tickfont) + self._set_property("tickformat", arg, tickformat) + self._set_property("tickformatstops", arg, tickformatstops) + self._set_property("tickformatstopdefaults", arg, tickformatstopdefaults) + self._set_property("ticklabeloverflow", arg, ticklabeloverflow) + self._set_property("ticklabelposition", arg, ticklabelposition) + self._set_property("ticklabelstep", arg, ticklabelstep) + self._set_property("ticklen", arg, ticklen) + self._set_property("tickmode", arg, tickmode) + self._set_property("tickprefix", arg, tickprefix) + self._set_property("ticks", arg, ticks) + self._set_property("ticksuffix", arg, ticksuffix) + self._set_property("ticktext", arg, ticktext) + self._set_property("ticktextsrc", arg, ticktextsrc) + self._set_property("tickvals", arg, tickvals) + self._set_property("tickvalssrc", arg, tickvalssrc) + self._set_property("tickwidth", arg, tickwidth) + self._set_property("title", arg, title) + self._set_property("x", arg, x) + self._set_property("xanchor", arg, xanchor) + self._set_property("xpad", arg, xpad) + self._set_property("xref", arg, xref) + self._set_property("y", arg, y) + self._set_property("yanchor", arg, yanchor) + self._set_property("ypad", arg, ypad) + self._set_property("yref", arg, yref) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_contour.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_contour.py new file mode 100644 index 0000000..61a81b5 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_contour.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Contour(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.contour" + _valid_props = {"color", "show", "width"} + + @property + def color(self): + """ + Sets the color of the contour lines. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def show(self): + """ + Sets whether or not dynamic contours are shown on hover + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def width(self): + """ + Sets the width of the contour lines. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [1, 16] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + """ + + def __init__(self, arg=None, color=None, show=None, width=None, **kwargs): + """ + Construct a new Contour object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Contour` + color + Sets the color of the contour lines. + show + Sets whether or not dynamic contours are shown on hover + width + Sets the width of the contour lines. + + Returns + ------- + Contour + """ + super().__init__("contour") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Contour +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Contour`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("show", arg, show) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_hoverlabel.py new file mode 100644 index 0000000..1236f19 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.volume.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_legendgrouptitle.py new file mode 100644 index 0000000..5d92a29 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.volume.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lighting.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lighting.py new file mode 100644 index 0000000..3d01d1e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lighting.py @@ -0,0 +1,260 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lighting(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.lighting" + _valid_props = { + "ambient", + "diffuse", + "facenormalsepsilon", + "fresnel", + "roughness", + "specular", + "vertexnormalsepsilon", + } + + @property + def ambient(self): + """ + Ambient light increases overall color visibility but can wash + out the image. + + The 'ambient' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["ambient"] + + @ambient.setter + def ambient(self, val): + self["ambient"] = val + + @property + def diffuse(self): + """ + Represents the extent that incident rays are reflected in a + range of angles. + + The 'diffuse' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["diffuse"] + + @diffuse.setter + def diffuse(self, val): + self["diffuse"] = val + + @property + def facenormalsepsilon(self): + """ + Epsilon for face normals calculation avoids math issues arising + from degenerate geometry. + + The 'facenormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["facenormalsepsilon"] + + @facenormalsepsilon.setter + def facenormalsepsilon(self, val): + self["facenormalsepsilon"] = val + + @property + def fresnel(self): + """ + Represents the reflectance as a dependency of the viewing + angle; e.g. paper is reflective when viewing it from the edge + of the paper (almost 90 degrees), causing shine. + + The 'fresnel' property is a number and may be specified as: + - An int or float in the interval [0, 5] + + Returns + ------- + int|float + """ + return self["fresnel"] + + @fresnel.setter + def fresnel(self, val): + self["fresnel"] = val + + @property + def roughness(self): + """ + Alters specular reflection; the rougher the surface, the wider + and less contrasty the shine. + + The 'roughness' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["roughness"] + + @roughness.setter + def roughness(self, val): + self["roughness"] = val + + @property + def specular(self): + """ + Represents the level that incident rays are reflected in a + single direction, causing shine. + + The 'specular' property is a number and may be specified as: + - An int or float in the interval [0, 2] + + Returns + ------- + int|float + """ + return self["specular"] + + @specular.setter + def specular(self, val): + self["specular"] = val + + @property + def vertexnormalsepsilon(self): + """ + Epsilon for vertex normals calculation avoids math issues + arising from degenerate geometry. + + The 'vertexnormalsepsilon' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["vertexnormalsepsilon"] + + @vertexnormalsepsilon.setter + def vertexnormalsepsilon(self, val): + self["vertexnormalsepsilon"] = val + + @property + def _prop_descriptions(self): + return """\ + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + """ + + def __init__( + self, + arg=None, + ambient=None, + diffuse=None, + facenormalsepsilon=None, + fresnel=None, + roughness=None, + specular=None, + vertexnormalsepsilon=None, + **kwargs, + ): + """ + Construct a new Lighting object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Lighting` + ambient + Ambient light increases overall color visibility but + can wash out the image. + diffuse + Represents the extent that incident rays are reflected + in a range of angles. + facenormalsepsilon + Epsilon for face normals calculation avoids math issues + arising from degenerate geometry. + fresnel + Represents the reflectance as a dependency of the + viewing angle; e.g. paper is reflective when viewing it + from the edge of the paper (almost 90 degrees), causing + shine. + roughness + Alters specular reflection; the rougher the surface, + the wider and less contrasty the shine. + specular + Represents the level that incident rays are reflected + in a single direction, causing shine. + vertexnormalsepsilon + Epsilon for vertex normals calculation avoids math + issues arising from degenerate geometry. + + Returns + ------- + Lighting + """ + super().__init__("lighting") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Lighting +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Lighting`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("ambient", arg, ambient) + self._set_property("diffuse", arg, diffuse) + self._set_property("facenormalsepsilon", arg, facenormalsepsilon) + self._set_property("fresnel", arg, fresnel) + self._set_property("roughness", arg, roughness) + self._set_property("specular", arg, specular) + self._set_property("vertexnormalsepsilon", arg, vertexnormalsepsilon) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lightposition.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lightposition.py new file mode 100644 index 0000000..50fcd20 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_lightposition.py @@ -0,0 +1,129 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Lightposition(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.lightposition" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + Numeric vector, representing the X coordinate for each vertex. + + The 'x' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + Numeric vector, representing the Y coordinate for each vertex. + + The 'y' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + Numeric vector, representing the Z coordinate for each vertex. + + The 'z' property is a number and may be specified as: + - An int or float in the interval [-100000, 100000] + + Returns + ------- + int|float + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Lightposition object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Lightposition` + x + Numeric vector, representing the X coordinate for each + vertex. + y + Numeric vector, representing the Y coordinate for each + vertex. + z + Numeric vector, representing the Z coordinate for each + vertex. + + Returns + ------- + Lightposition + """ + super().__init__("lightposition") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Lightposition +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Lightposition`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_slices.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_slices.py new file mode 100644 index 0000000..6faf4de --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_slices.py @@ -0,0 +1,131 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Slices(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.slices" + _valid_props = {"x", "y", "z"} + + @property + def x(self): + """ + The 'x' property is an instance of X + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.slices.X` + - A dict of string/value properties that will be passed + to the X constructor + + Returns + ------- + plotly.graph_objs.volume.slices.X + """ + return self["x"] + + @x.setter + def x(self, val): + self["x"] = val + + @property + def y(self): + """ + The 'y' property is an instance of Y + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.slices.Y` + - A dict of string/value properties that will be passed + to the Y constructor + + Returns + ------- + plotly.graph_objs.volume.slices.Y + """ + return self["y"] + + @y.setter + def y(self, val): + self["y"] = val + + @property + def z(self): + """ + The 'z' property is an instance of Z + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.slices.Z` + - A dict of string/value properties that will be passed + to the Z constructor + + Returns + ------- + plotly.graph_objs.volume.slices.Z + """ + return self["z"] + + @z.setter + def z(self, val): + self["z"] = val + + @property + def _prop_descriptions(self): + return """\ + x + :class:`plotly.graph_objects.volume.slices.X` instance + or dict with compatible properties + y + :class:`plotly.graph_objects.volume.slices.Y` instance + or dict with compatible properties + z + :class:`plotly.graph_objects.volume.slices.Z` instance + or dict with compatible properties + """ + + def __init__(self, arg=None, x=None, y=None, z=None, **kwargs): + """ + Construct a new Slices object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.Slices` + x + :class:`plotly.graph_objects.volume.slices.X` instance + or dict with compatible properties + y + :class:`plotly.graph_objects.volume.slices.Y` instance + or dict with compatible properties + z + :class:`plotly.graph_objects.volume.slices.Z` instance + or dict with compatible properties + + Returns + ------- + Slices + """ + super().__init__("slices") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Slices +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Slices`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("x", arg, x) + self._set_property("y", arg, y) + self._set_property("z", arg, z) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_spaceframe.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_spaceframe.py new file mode 100644 index 0000000..ff07188 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_spaceframe.py @@ -0,0 +1,117 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Spaceframe(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.spaceframe" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `spaceframe` elements. The default + fill value is 1 meaning that they are entirely shaded. Applying + a `fill` ratio less than one would allow the creation of + openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Displays/hides tetrahedron shapes between minimum and maximum + iso-values. Often useful when either caps or surfaces are + disabled or filled with values less than 1. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `spaceframe` elements. The + default fill value is 1 meaning that they are entirely + shaded. Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + show + Displays/hides tetrahedron shapes between minimum and + maximum iso-values. Often useful when either caps or + surfaces are disabled or filled with values less than + 1. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Spaceframe object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Spaceframe` + fill + Sets the fill ratio of the `spaceframe` elements. The + default fill value is 1 meaning that they are entirely + shaded. Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + show + Displays/hides tetrahedron shapes between minimum and + maximum iso-values. Often useful when either caps or + surfaces are disabled or filled with values less than + 1. + + Returns + ------- + Spaceframe + """ + super().__init__("spaceframe") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Spaceframe +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Spaceframe`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_stream.py new file mode 100644 index 0000000..272624b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_stream.py @@ -0,0 +1,113 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_surface.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_surface.py new file mode 100644 index 0000000..0f35f1b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/_surface.py @@ -0,0 +1,193 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Surface(_BaseTraceHierarchyType): + _parent_path_str = "volume" + _path_str = "volume.surface" + _valid_props = {"count", "fill", "pattern", "show"} + + @property + def count(self): + """ + Sets the number of iso-surfaces between minimum and maximum + iso-values. By default this value is 2 meaning that only + minimum and maximum surfaces would be drawn. + + The 'count' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 9223372036854775807] + + Returns + ------- + int + """ + return self["count"] + + @count.setter + def count(self, val): + self["count"] = val + + @property + def fill(self): + """ + Sets the fill ratio of the iso-surface. The default fill value + of the surface is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def pattern(self): + """ + Sets the surface pattern of the iso-surface 3-D sections. The + default pattern of the surface is `all` meaning that the rest + of surface elements would be shaded. The check options (either + 1 or 2) could be used to draw half of the squares on the + surface. Using various combinations of capital `A`, `B`, `C`, + `D` and `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of interest. + + The 'pattern' property is a flaglist and may be specified + as a string containing: + - Any combination of ['A', 'B', 'C', 'D', 'E'] joined with '+' characters + (e.g. 'A+B') + OR exactly one of ['all', 'odd', 'even'] (e.g. 'even') + + Returns + ------- + Any + """ + return self["pattern"] + + @pattern.setter + def pattern(self, val): + self["pattern"] = val + + @property + def show(self): + """ + Hides/displays surfaces between minimum and maximum iso-values. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + count + Sets the number of iso-surfaces between minimum and + maximum iso-values. By default this value is 2 meaning + that only minimum and maximum surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The default + fill value of the surface is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is `all` + meaning that the rest of surface elements would be + shaded. The check options (either 1 or 2) could be used + to draw half of the squares on the surface. Using + various combinations of capital `A`, `B`, `C`, `D` and + `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and maximum + iso-values. + """ + + def __init__( + self, arg=None, count=None, fill=None, pattern=None, show=None, **kwargs + ): + """ + Construct a new Surface object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.Surface` + count + Sets the number of iso-surfaces between minimum and + maximum iso-values. By default this value is 2 meaning + that only minimum and maximum surfaces would be drawn. + fill + Sets the fill ratio of the iso-surface. The default + fill value of the surface is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + pattern + Sets the surface pattern of the iso-surface 3-D + sections. The default pattern of the surface is `all` + meaning that the rest of surface elements would be + shaded. The check options (either 1 or 2) could be used + to draw half of the squares on the surface. Using + various combinations of capital `A`, `B`, `C`, `D` and + `E` may also be used to reduce the number of triangles + on the iso-surfaces and creating other patterns of + interest. + show + Hides/displays surfaces between minimum and maximum + iso-values. + + Returns + ------- + Surface + """ + super().__init__("surface") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.Surface +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.Surface`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("count", arg, count) + self._set_property("fill", arg, fill) + self._set_property("pattern", arg, pattern) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/__init__.py new file mode 100644 index 0000000..3802eba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._x import X + from ._y import Y + from ._z import Z +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._x.X", "._y.Y", "._z.Z"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_x.py new file mode 100644 index 0000000..2c3c692 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_x.py @@ -0,0 +1,121 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + _parent_path_str = "volume.caps" + _path_str = "volume.caps.x" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + the `caps` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the x `slices` is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the x `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.caps.X` + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the x `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + + Returns + ------- + X + """ + super().__init__("x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.caps.X +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.caps.X`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_y.py new file mode 100644 index 0000000..6ad9bde --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_y.py @@ -0,0 +1,121 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + _parent_path_str = "volume.caps" + _path_str = "volume.caps.y" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + the `caps` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the y `slices` is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the y `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.caps.Y` + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the y `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + + Returns + ------- + Y + """ + super().__init__("y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.caps.Y +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.caps.Y`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_z.py new file mode 100644 index 0000000..37064fd --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/caps/_z.py @@ -0,0 +1,121 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + _parent_path_str = "volume.caps" + _path_str = "volume.caps.z" + _valid_props = {"fill", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `caps`. The default fill value of + the `caps` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def show(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the z `slices` is 1 meaning that they are entirely shaded. On + the other hand Applying a `fill` ratio less than one would + allow the creation of openings parallel to the edges. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the z `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + """ + + def __init__(self, arg=None, fill=None, show=None, **kwargs): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.caps.Z` + fill + Sets the fill ratio of the `caps`. The default fill + value of the `caps` is 1 meaning that they are entirely + shaded. On the other hand Applying a `fill` ratio less + than one would allow the creation of openings parallel + to the edges. + show + Sets the fill ratio of the `slices`. The default fill + value of the z `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + + Returns + ------- + Z + """ + super().__init__("z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.caps.Z +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.caps.Z`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/__init__.py new file mode 100644 index 0000000..4690d3c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/__init__.py @@ -0,0 +1,16 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._tickfont import Tickfont + from ._tickformatstop import Tickformatstop + from ._title import Title + from . import title +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [".title"], + ["._tickfont.Tickfont", "._tickformatstop.Tickformatstop", "._title.Title"], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickfont.py new file mode 100644 index 0000000..ad46aa7 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickfont.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickfont(_BaseTraceHierarchyType): + _parent_path_str = "volume.colorbar" + _path_str = "volume.colorbar.tickfont" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Tickfont object + + Sets the color bar's tick label font + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.colorbar.Tickfont` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Tickfont + """ + super().__init__("tickfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.colorbar.Tickfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.colorbar.Tickfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickformatstop.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickformatstop.py new file mode 100644 index 0000000..67ddb27 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_tickformatstop.py @@ -0,0 +1,241 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Tickformatstop(_BaseTraceHierarchyType): + _parent_path_str = "volume.colorbar" + _path_str = "volume.colorbar.tickformatstop" + _valid_props = {"dtickrange", "enabled", "name", "templateitemname", "value"} + + @property + def dtickrange(self): + """ + range [*min*, *max*], where "min", "max" - dtick values which + describe some zoom level, it is possible to omit "min" or "max" + value by passing "null" + + The 'dtickrange' property is an info array that may be specified as: + + * a list or tuple of 2 elements where: + (0) The 'dtickrange[0]' property accepts values of any type + (1) The 'dtickrange[1]' property accepts values of any type + + Returns + ------- + list + """ + return self["dtickrange"] + + @dtickrange.setter + def dtickrange(self, val): + self["dtickrange"] = val + + @property + def enabled(self): + """ + Determines whether or not this stop is used. If `false`, this + stop is ignored even within its `dtickrange`. + + The 'enabled' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["enabled"] + + @enabled.setter + def enabled(self, val): + self["enabled"] = val + + @property + def name(self): + """ + When used in a template, named items are created in the output + figure in addition to any items the figure already has in this + array. You can modify these items in the output figure by + making your own item with `templateitemname` matching this + `name` alongside your modifications (including `visible: false` + or `enabled: false` to hide it). Has no effect outside of a + template. + + The 'name' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["name"] + + @name.setter + def name(self, val): + self["name"] = val + + @property + def templateitemname(self): + """ + Used to refer to a named item in this array in the template. + Named items from the template will be created even without a + matching item in the input figure, but you can modify one by + making an item with `templateitemname` matching its `name`, + alongside your modifications (including `visible: false` or + `enabled: false` to hide it). If there is no template or no + matching item, this item will be hidden unless you explicitly + show it with `visible: true`. + + The 'templateitemname' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["templateitemname"] + + @templateitemname.setter + def templateitemname(self, val): + self["templateitemname"] = val + + @property + def value(self): + """ + string - dtickformat for described zoom level, the same as + "tickformat" + + The 'value' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["value"] + + @value.setter + def value(self, val): + self["value"] = val + + @property + def _prop_descriptions(self): + return """\ + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + """ + + def __init__( + self, + arg=None, + dtickrange=None, + enabled=None, + name=None, + templateitemname=None, + value=None, + **kwargs, + ): + """ + Construct a new Tickformatstop object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.volume.colorba + r.Tickformatstop` + dtickrange + range [*min*, *max*], where "min", "max" - dtick values + which describe some zoom level, it is possible to omit + "min" or "max" value by passing "null" + enabled + Determines whether or not this stop is used. If + `false`, this stop is ignored even within its + `dtickrange`. + name + When used in a template, named items are created in the + output figure in addition to any items the figure + already has in this array. You can modify these items + in the output figure by making your own item with + `templateitemname` matching this `name` alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). Has no effect outside of a + template. + templateitemname + Used to refer to a named item in this array in the + template. Named items from the template will be created + even without a matching item in the input figure, but + you can modify one by making an item with + `templateitemname` matching its `name`, alongside your + modifications (including `visible: false` or `enabled: + false` to hide it). If there is no template or no + matching item, this item will be hidden unless you + explicitly show it with `visible: true`. + value + string - dtickformat for described zoom level, the same + as "tickformat" + + Returns + ------- + Tickformatstop + """ + super().__init__("tickformatstops") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.colorbar.Tickformatstop +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.colorbar.Tickformatstop`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("dtickrange", arg, dtickrange) + self._set_property("enabled", arg, enabled) + self._set_property("name", arg, name) + self._set_property("templateitemname", arg, templateitemname) + self._set_property("value", arg, value) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_title.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_title.py new file mode 100644 index 0000000..17a9258 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/_title.py @@ -0,0 +1,136 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Title(_BaseTraceHierarchyType): + _parent_path_str = "volume.colorbar" + _path_str = "volume.colorbar.title" + _valid_props = {"font", "side", "text"} + + @property + def font(self): + """ + Sets this color bar's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.volume.colorbar.title.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.volume.colorbar.title.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def side(self): + """ + Determines the location of color bar's title with respect to + the color bar. Defaults to "top" when `orientation` if "v" and + defaults to "right" when `orientation` if "h". + + The 'side' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['right', 'top', 'bottom'] + + Returns + ------- + Any + """ + return self["side"] + + @side.setter + def side(self, val): + self["side"] = val + + @property + def text(self): + """ + Sets the title of the color bar. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + """ + + def __init__(self, arg=None, font=None, side=None, text=None, **kwargs): + """ + Construct a new Title object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.colorbar.Title` + font + Sets this color bar's title font. + side + Determines the location of color bar's title with + respect to the color bar. Defaults to "top" when + `orientation` if "v" and defaults to "right" when + `orientation` if "h". + text + Sets the title of the color bar. + + Returns + ------- + Title + """ + super().__init__("title") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.colorbar.Title +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.colorbar.Title`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("side", arg, side) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/_font.py new file mode 100644 index 0000000..cf0cb0d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/colorbar/title/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "volume.colorbar.title" + _path_str = "volume.colorbar.title.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this color bar's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.colorbar.title.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.colorbar.title.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.colorbar.title.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/_font.py new file mode 100644 index 0000000..43ab7f3 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "volume.hoverlabel" + _path_str = "volume.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/_font.py new file mode 100644 index 0000000..59553af --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "volume.legendgrouptitle" + _path_str = "volume.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.legendgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/__init__.py new file mode 100644 index 0000000..3802eba --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/__init__.py @@ -0,0 +1,13 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._x import X + from ._y import Y + from ._z import Z +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [], ["._x.X", "._y.Y", "._z.Z"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_x.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_x.py new file mode 100644 index 0000000..b77e2c4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_x.py @@ -0,0 +1,177 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class X(_BaseTraceHierarchyType): + _parent_path_str = "volume.slices" + _path_str = "volume.slices.x" + _valid_props = {"fill", "locations", "locationssrc", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the `slices` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + specified slices would be created for all points of the axis x + except start and end. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def show(self): + """ + Determines whether or not slice planes about the x dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis x except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the x + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs, + ): + """ + Construct a new X object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.slices.X` + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis x except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the x + dimension are drawn. + + Returns + ------- + X + """ + super().__init__("x") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.slices.X +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.slices.X`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_y.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_y.py new file mode 100644 index 0000000..feb3622 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_y.py @@ -0,0 +1,177 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Y(_BaseTraceHierarchyType): + _parent_path_str = "volume.slices" + _path_str = "volume.slices.y" + _valid_props = {"fill", "locations", "locationssrc", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the `slices` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + specified slices would be created for all points of the axis y + except start and end. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def show(self): + """ + Determines whether or not slice planes about the y dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis y except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the y + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs, + ): + """ + Construct a new Y object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.slices.Y` + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis y except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the y + dimension are drawn. + + Returns + ------- + Y + """ + super().__init__("y") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.slices.Y +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.slices.Y`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_z.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_z.py new file mode 100644 index 0000000..4b37d9d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/volume/slices/_z.py @@ -0,0 +1,177 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Z(_BaseTraceHierarchyType): + _parent_path_str = "volume.slices" + _path_str = "volume.slices.z" + _valid_props = {"fill", "locations", "locationssrc", "show"} + + @property + def fill(self): + """ + Sets the fill ratio of the `slices`. The default fill value of + the `slices` is 1 meaning that they are entirely shaded. On the + other hand Applying a `fill` ratio less than one would allow + the creation of openings parallel to the edges. + + The 'fill' property is a number and may be specified as: + - An int or float in the interval [0, 1] + + Returns + ------- + int|float + """ + return self["fill"] + + @fill.setter + def fill(self, val): + self["fill"] = val + + @property + def locations(self): + """ + Specifies the location(s) of slices on the axis. When not + specified slices would be created for all points of the axis z + except start and end. + + The 'locations' property is an array that may be specified as a tuple, + list, numpy array, or pandas Series + + Returns + ------- + numpy.ndarray + """ + return self["locations"] + + @locations.setter + def locations(self, val): + self["locations"] = val + + @property + def locationssrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `locations`. + + The 'locationssrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["locationssrc"] + + @locationssrc.setter + def locationssrc(self, val): + self["locationssrc"] = val + + @property + def show(self): + """ + Determines whether or not slice planes about the z dimension + are drawn. + + The 'show' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["show"] + + @show.setter + def show(self, val): + self["show"] = val + + @property + def _prop_descriptions(self): + return """\ + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis z except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the z + dimension are drawn. + """ + + def __init__( + self, + arg=None, + fill=None, + locations=None, + locationssrc=None, + show=None, + **kwargs, + ): + """ + Construct a new Z object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.volume.slices.Z` + fill + Sets the fill ratio of the `slices`. The default fill + value of the `slices` is 1 meaning that they are + entirely shaded. On the other hand Applying a `fill` + ratio less than one would allow the creation of + openings parallel to the edges. + locations + Specifies the location(s) of slices on the axis. When + not specified slices would be created for all points of + the axis z except start and end. + locationssrc + Sets the source reference on Chart Studio Cloud for + `locations`. + show + Determines whether or not slice planes about the z + dimension are drawn. + + Returns + ------- + Z + """ + super().__init__("z") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.volume.slices.Z +constructor must be a dict or +an instance of :class:`plotly.graph_objs.volume.slices.Z`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("fill", arg, fill) + self._set_property("locations", arg, locations) + self._set_property("locationssrc", arg, locationssrc) + self._set_property("show", arg, show) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/__init__.py new file mode 100644 index 0000000..e6bb5e4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/__init__.py @@ -0,0 +1,46 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._connector import Connector + from ._decreasing import Decreasing + from ._hoverlabel import Hoverlabel + from ._increasing import Increasing + from ._insidetextfont import Insidetextfont + from ._legendgrouptitle import Legendgrouptitle + from ._outsidetextfont import Outsidetextfont + from ._stream import Stream + from ._textfont import Textfont + from ._totals import Totals + from . import connector + from . import decreasing + from . import hoverlabel + from . import increasing + from . import legendgrouptitle + from . import totals +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, + [ + ".connector", + ".decreasing", + ".hoverlabel", + ".increasing", + ".legendgrouptitle", + ".totals", + ], + [ + "._connector.Connector", + "._decreasing.Decreasing", + "._hoverlabel.Hoverlabel", + "._increasing.Increasing", + "._insidetextfont.Insidetextfont", + "._legendgrouptitle.Legendgrouptitle", + "._outsidetextfont.Outsidetextfont", + "._stream.Stream", + "._textfont.Textfont", + "._totals.Totals", + ], + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_connector.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_connector.py new file mode 100644 index 0000000..e76bd9d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_connector.py @@ -0,0 +1,127 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Connector(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.connector" + _valid_props = {"line", "mode", "visible"} + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.connector.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.waterfall.connector.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def mode(self): + """ + Sets the shape of connector lines. + + The 'mode' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['spanning', 'between'] + + Returns + ------- + Any + """ + return self["mode"] + + @mode.setter + def mode(self, val): + self["mode"] = val + + @property + def visible(self): + """ + Determines if connector lines are drawn. + + The 'visible' property must be specified as a bool + (either True, or False) + + Returns + ------- + bool + """ + return self["visible"] + + @visible.setter + def visible(self, val): + self["visible"] = val + + @property + def _prop_descriptions(self): + return """\ + line + :class:`plotly.graph_objects.waterfall.connector.Line` + instance or dict with compatible properties + mode + Sets the shape of connector lines. + visible + Determines if connector lines are drawn. + """ + + def __init__(self, arg=None, line=None, mode=None, visible=None, **kwargs): + """ + Construct a new Connector object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Connector` + line + :class:`plotly.graph_objects.waterfall.connector.Line` + instance or dict with compatible properties + mode + Sets the shape of connector lines. + visible + Determines if connector lines are drawn. + + Returns + ------- + Connector + """ + super().__init__("connector") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Connector +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Connector`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("line", arg, line) + self._set_property("mode", arg, mode) + self._set_property("visible", arg, visible) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_decreasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_decreasing.py new file mode 100644 index 0000000..b472b42 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_decreasing.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Decreasing(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.decreasing" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.decreasing.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.waterfall.decreasing.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.waterfall.decreasing.Marke + r` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Decreasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Decreasing` + marker + :class:`plotly.graph_objects.waterfall.decreasing.Marke + r` instance or dict with compatible properties + + Returns + ------- + Decreasing + """ + super().__init__("decreasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Decreasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Decreasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_hoverlabel.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_hoverlabel.py new file mode 100644 index 0000000..8d7176b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_hoverlabel.py @@ -0,0 +1,338 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Hoverlabel(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.hoverlabel" + _valid_props = { + "align", + "alignsrc", + "bgcolor", + "bgcolorsrc", + "bordercolor", + "bordercolorsrc", + "font", + "namelength", + "namelengthsrc", + } + + @property + def align(self): + """ + Sets the horizontal alignment of the text content within hover + label box. Has an effect only if the hover label text spans + more two or more lines + + The 'align' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['left', 'right', 'auto'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["align"] + + @align.setter + def align(self, val): + self["align"] = val + + @property + def alignsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `align`. + + The 'alignsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["alignsrc"] + + @alignsrc.setter + def alignsrc(self, val): + self["alignsrc"] = val + + @property + def bgcolor(self): + """ + Sets the background color of the hover labels for this trace + + The 'bgcolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bgcolor"] + + @bgcolor.setter + def bgcolor(self, val): + self["bgcolor"] = val + + @property + def bgcolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `bgcolor`. + + The 'bgcolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bgcolorsrc"] + + @bgcolorsrc.setter + def bgcolorsrc(self, val): + self["bgcolorsrc"] = val + + @property + def bordercolor(self): + """ + Sets the border color of the hover labels for this trace. + + The 'bordercolor' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["bordercolor"] + + @bordercolor.setter + def bordercolor(self, val): + self["bordercolor"] = val + + @property + def bordercolorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + + The 'bordercolorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["bordercolorsrc"] + + @bordercolorsrc.setter + def bordercolorsrc(self, val): + self["bordercolorsrc"] = val + + @property + def font(self): + """ + Sets the font used in hover labels. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.hoverlabel.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.waterfall.hoverlabel.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def namelength(self): + """ + Sets the default length (in number of characters) of the trace + name in the hover labels for all traces. -1 shows the whole + name regardless of length. 0-3 shows the first 0-3 characters, + and an integer >3 will show the whole name if it is less than + that many characters, but if it is longer, will truncate to + `namelength - 3` characters and add an ellipsis. + + The 'namelength' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [-1, 9223372036854775807] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["namelength"] + + @namelength.setter + def namelength(self, val): + self["namelength"] = val + + @property + def namelengthsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `namelength`. + + The 'namelengthsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["namelengthsrc"] + + @namelengthsrc.setter + def namelengthsrc(self, val): + self["namelengthsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + """ + + def __init__( + self, + arg=None, + align=None, + alignsrc=None, + bgcolor=None, + bgcolorsrc=None, + bordercolor=None, + bordercolorsrc=None, + font=None, + namelength=None, + namelengthsrc=None, + **kwargs, + ): + """ + Construct a new Hoverlabel object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Hoverlabel` + align + Sets the horizontal alignment of the text content + within hover label box. Has an effect only if the hover + label text spans more two or more lines + alignsrc + Sets the source reference on Chart Studio Cloud for + `align`. + bgcolor + Sets the background color of the hover labels for this + trace + bgcolorsrc + Sets the source reference on Chart Studio Cloud for + `bgcolor`. + bordercolor + Sets the border color of the hover labels for this + trace. + bordercolorsrc + Sets the source reference on Chart Studio Cloud for + `bordercolor`. + font + Sets the font used in hover labels. + namelength + Sets the default length (in number of characters) of + the trace name in the hover labels for all traces. -1 + shows the whole name regardless of length. 0-3 shows + the first 0-3 characters, and an integer >3 will show + the whole name if it is less than that many characters, + but if it is longer, will truncate to `namelength - 3` + characters and add an ellipsis. + namelengthsrc + Sets the source reference on Chart Studio Cloud for + `namelength`. + + Returns + ------- + Hoverlabel + """ + super().__init__("hoverlabel") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Hoverlabel +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Hoverlabel`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("align", arg, align) + self._set_property("alignsrc", arg, alignsrc) + self._set_property("bgcolor", arg, bgcolor) + self._set_property("bgcolorsrc", arg, bgcolorsrc) + self._set_property("bordercolor", arg, bordercolor) + self._set_property("bordercolorsrc", arg, bordercolorsrc) + self._set_property("font", arg, font) + self._set_property("namelength", arg, namelength) + self._set_property("namelengthsrc", arg, namelengthsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_increasing.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_increasing.py new file mode 100644 index 0000000..1a2d447 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_increasing.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Increasing(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.increasing" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.increasing.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.waterfall.increasing.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.waterfall.increasing.Marke + r` instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Increasing object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Increasing` + marker + :class:`plotly.graph_objects.waterfall.increasing.Marke + r` instance or dict with compatible properties + + Returns + ------- + Increasing + """ + super().__init__("increasing") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Increasing +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Increasing`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_insidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_insidetextfont.py new file mode 100644 index 0000000..a316c5f --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_insidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Insidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.insidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Insidetextfont object + + Sets the font used for `text` lying inside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Insidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Insidetextfont + """ + super().__init__("insidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Insidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Insidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_legendgrouptitle.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_legendgrouptitle.py new file mode 100644 index 0000000..9b29501 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_legendgrouptitle.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Legendgrouptitle(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.legendgrouptitle" + _valid_props = {"font", "text"} + + @property + def font(self): + """ + Sets this legend group's title font. + + The 'font' property is an instance of Font + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.legendgrouptitle.Font` + - A dict of string/value properties that will be passed + to the Font constructor + + Returns + ------- + plotly.graph_objs.waterfall.legendgrouptitle.Font + """ + return self["font"] + + @font.setter + def font(self, val): + self["font"] = val + + @property + def text(self): + """ + Sets the title of the legend group. + + The 'text' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["text"] + + @text.setter + def text(self, val): + self["text"] = val + + @property + def _prop_descriptions(self): + return """\ + font + Sets this legend group's title font. + text + Sets the title of the legend group. + """ + + def __init__(self, arg=None, font=None, text=None, **kwargs): + """ + Construct a new Legendgrouptitle object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Legendgrouptitle` + font + Sets this legend group's title font. + text + Sets the title of the legend group. + + Returns + ------- + Legendgrouptitle + """ + super().__init__("legendgrouptitle") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Legendgrouptitle +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Legendgrouptitle`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("font", arg, font) + self._set_property("text", arg, text) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_outsidetextfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_outsidetextfont.py new file mode 100644 index 0000000..8e1371b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_outsidetextfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Outsidetextfont(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.outsidetextfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Outsidetextfont object + + Sets the font used for `text` lying outside the bar. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Outsidetextfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Outsidetextfont + """ + super().__init__("outsidetextfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Outsidetextfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Outsidetextfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_stream.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_stream.py new file mode 100644 index 0000000..488e44d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_stream.py @@ -0,0 +1,114 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Stream(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.stream" + _valid_props = {"maxpoints", "token"} + + @property + def maxpoints(self): + """ + Sets the maximum number of points to keep on the plots from an + incoming stream. If `maxpoints` is set to 50, only the newest + 50 points will be displayed on the plot. + + The 'maxpoints' property is a number and may be specified as: + - An int or float in the interval [0, 10000] + + Returns + ------- + int|float + """ + return self["maxpoints"] + + @maxpoints.setter + def maxpoints(self, val): + self["maxpoints"] = val + + @property + def token(self): + """ + The stream id number links a data trace on a plot with a + stream. See https://chart-studio.plotly.com/settings for more + details. + + The 'token' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["token"] + + @token.setter + def token(self, val): + self["token"] = val + + @property + def _prop_descriptions(self): + return """\ + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + """ + + def __init__(self, arg=None, maxpoints=None, token=None, **kwargs): + """ + Construct a new Stream object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Stream` + maxpoints + Sets the maximum number of points to keep on the plots + from an incoming stream. If `maxpoints` is set to 50, + only the newest 50 points will be displayed on the + plot. + token + The stream id number links a data trace on a plot with + a stream. See https://chart-studio.plotly.com/settings + for more details. + + Returns + ------- + Stream + """ + super().__init__("stream") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Stream +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Stream`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("maxpoints", arg, maxpoints) + self._set_property("token", arg, token) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_textfont.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_textfont.py new file mode 100644 index 0000000..5f6640e --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_textfont.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Textfont(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.textfont" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Textfont object + + Sets the font used for `text`. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Textfont` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Textfont + """ + super().__init__("textfont") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Textfont +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Textfont`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_totals.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_totals.py new file mode 100644 index 0000000..d7f4431 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/_totals.py @@ -0,0 +1,80 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Totals(_BaseTraceHierarchyType): + _parent_path_str = "waterfall" + _path_str = "waterfall.totals" + _valid_props = {"marker"} + + @property + def marker(self): + """ + The 'marker' property is an instance of Marker + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.totals.Marker` + - A dict of string/value properties that will be passed + to the Marker constructor + + Returns + ------- + plotly.graph_objs.waterfall.totals.Marker + """ + return self["marker"] + + @marker.setter + def marker(self, val): + self["marker"] = val + + @property + def _prop_descriptions(self): + return """\ + marker + :class:`plotly.graph_objects.waterfall.totals.Marker` + instance or dict with compatible properties + """ + + def __init__(self, arg=None, marker=None, **kwargs): + """ + Construct a new Totals object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.Totals` + marker + :class:`plotly.graph_objects.waterfall.totals.Marker` + instance or dict with compatible properties + + Returns + ------- + Totals + """ + super().__init__("totals") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.Totals +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.Totals`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("marker", arg, marker) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/_line.py new file mode 100644 index 0000000..299b5ea --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/connector/_line.py @@ -0,0 +1,139 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.connector" + _path_str = "waterfall.connector.line" + _valid_props = {"color", "dash", "width"} + + @property + def color(self): + """ + Sets the line color. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def dash(self): + """ + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + + The 'dash' property is an enumeration that may be specified as: + - One of the following dash styles: + ['solid', 'dot', 'dash', 'longdash', 'dashdot', 'longdashdot'] + - A string containing a dash length list in pixels or percentages + (e.g. '5px 10px 2px 2px', '5, 10, 2, 2', '10% 20% 40%', etc.) + + Returns + ------- + str + """ + return self["dash"] + + @dash.setter + def dash(self, val): + self["dash"] = val + + @property + def width(self): + """ + Sets the line width (in px). + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + """ + + def __init__(self, arg=None, color=None, dash=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.connector.Line` + color + Sets the line color. + dash + Sets the dash style of lines. Set to a dash type string + ("solid", "dot", "dash", "longdash", "dashdot", or + "longdashdot") or a dash length list in px (eg + "5px,10px,2px,2px"). + width + Sets the line width (in px). + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.connector.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.connector.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("dash", arg, dash) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/__init__.py new file mode 100644 index 0000000..3ef756b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from . import marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".marker"], ["._marker.Marker"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/_marker.py new file mode 100644 index 0000000..a8f49ee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/_marker.py @@ -0,0 +1,107 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.decreasing" + _path_str = "waterfall.decreasing.marker" + _valid_props = {"color", "line"} + + @property + def color(self): + """ + Sets the marker color of all decreasing values. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.decreasing.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.waterfall.decreasing.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of all decreasing values. + line + :class:`plotly.graph_objects.waterfall.decreasing.marke + r.Line` instance or dict with compatible properties + """ + + def __init__(self, arg=None, color=None, line=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.decreasing.Marker` + color + Sets the marker color of all decreasing values. + line + :class:`plotly.graph_objects.waterfall.decreasing.marke + r.Line` instance or dict with compatible properties + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.decreasing.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.decreasing.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/_line.py new file mode 100644 index 0000000..746fdb4 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/decreasing/marker/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.decreasing.marker" + _path_str = "waterfall.decreasing.marker.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the line color of all decreasing values. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the line width of all decreasing values. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color of all decreasing values. + width + Sets the line width of all decreasing values. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.waterfall.decr + easing.marker.Line` + color + Sets the line color of all decreasing values. + width + Sets the line width of all decreasing values. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.decreasing.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.decreasing.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/_font.py new file mode 100644 index 0000000..025c5dc --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/hoverlabel/_font.py @@ -0,0 +1,587 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.hoverlabel" + _path_str = "waterfall.hoverlabel.font" + _valid_props = { + "color", + "colorsrc", + "family", + "familysrc", + "lineposition", + "linepositionsrc", + "shadow", + "shadowsrc", + "size", + "sizesrc", + "style", + "stylesrc", + "textcase", + "textcasesrc", + "variant", + "variantsrc", + "weight", + "weightsrc", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + - A list or array of any of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def colorsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `color`. + + The 'colorsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["colorsrc"] + + @colorsrc.setter + def colorsrc(self, val): + self["colorsrc"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def familysrc(self): + """ + Sets the source reference on Chart Studio Cloud for `family`. + + The 'familysrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["familysrc"] + + @familysrc.setter + def familysrc(self, val): + self["familysrc"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + - A list or array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def linepositionsrc(self): + """ + Sets the source reference on Chart Studio Cloud for + `lineposition`. + + The 'linepositionsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["linepositionsrc"] + + @linepositionsrc.setter + def linepositionsrc(self, val): + self["linepositionsrc"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + str|numpy.ndarray + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def shadowsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `shadow`. + + The 'shadowsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["shadowsrc"] + + @shadowsrc.setter + def shadowsrc(self, val): + self["shadowsrc"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|float|numpy.ndarray + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def sizesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `size`. + + The 'sizesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["sizesrc"] + + @sizesrc.setter + def sizesrc(self, val): + self["sizesrc"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def stylesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `style`. + + The 'stylesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["stylesrc"] + + @stylesrc.setter + def stylesrc(self, val): + self["stylesrc"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def textcasesrc(self): + """ + Sets the source reference on Chart Studio Cloud for `textcase`. + + The 'textcasesrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["textcasesrc"] + + @textcasesrc.setter + def textcasesrc(self, val): + self["textcasesrc"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + Any|numpy.ndarray + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def variantsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `variant`. + + The 'variantsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["variantsrc"] + + @variantsrc.setter + def variantsrc(self, val): + self["variantsrc"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + - A tuple, list, or one-dimensional numpy array of the above + + Returns + ------- + int|numpy.ndarray + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def weightsrc(self): + """ + Sets the source reference on Chart Studio Cloud for `weight`. + + The 'weightsrc' property must be specified as a string or + as a plotly.grid_objs.Column object + + Returns + ------- + str + """ + return self["weightsrc"] + + @weightsrc.setter + def weightsrc(self, val): + self["weightsrc"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + """ + + def __init__( + self, + arg=None, + color=None, + colorsrc=None, + family=None, + familysrc=None, + lineposition=None, + linepositionsrc=None, + shadow=None, + shadowsrc=None, + size=None, + sizesrc=None, + style=None, + stylesrc=None, + textcase=None, + textcasesrc=None, + variant=None, + variantsrc=None, + weight=None, + weightsrc=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets the font used in hover labels. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.hoverlabel.Font` + color + + colorsrc + Sets the source reference on Chart Studio Cloud for + `color`. + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + familysrc + Sets the source reference on Chart Studio Cloud for + `family`. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + linepositionsrc + Sets the source reference on Chart Studio Cloud for + `lineposition`. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + shadowsrc + Sets the source reference on Chart Studio Cloud for + `shadow`. + size + + sizesrc + Sets the source reference on Chart Studio Cloud for + `size`. + style + Sets whether a font should be styled with a normal or + italic face from its family. + stylesrc + Sets the source reference on Chart Studio Cloud for + `style`. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + textcasesrc + Sets the source reference on Chart Studio Cloud for + `textcase`. + variant + Sets the variant of the font. + variantsrc + Sets the source reference on Chart Studio Cloud for + `variant`. + weight + Sets the weight (or boldness) of the font. + weightsrc + Sets the source reference on Chart Studio Cloud for + `weight`. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.hoverlabel.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.hoverlabel.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("colorsrc", arg, colorsrc) + self._set_property("family", arg, family) + self._set_property("familysrc", arg, familysrc) + self._set_property("lineposition", arg, lineposition) + self._set_property("linepositionsrc", arg, linepositionsrc) + self._set_property("shadow", arg, shadow) + self._set_property("shadowsrc", arg, shadowsrc) + self._set_property("size", arg, size) + self._set_property("sizesrc", arg, sizesrc) + self._set_property("style", arg, style) + self._set_property("stylesrc", arg, stylesrc) + self._set_property("textcase", arg, textcase) + self._set_property("textcasesrc", arg, textcasesrc) + self._set_property("variant", arg, variant) + self._set_property("variantsrc", arg, variantsrc) + self._set_property("weight", arg, weight) + self._set_property("weightsrc", arg, weightsrc) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/__init__.py new file mode 100644 index 0000000..3ef756b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from . import marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".marker"], ["._marker.Marker"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/_marker.py new file mode 100644 index 0000000..3a77dee --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/_marker.py @@ -0,0 +1,107 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.increasing" + _path_str = "waterfall.increasing.marker" + _valid_props = {"color", "line"} + + @property + def color(self): + """ + Sets the marker color of all increasing values. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.increasing.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.waterfall.increasing.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of all increasing values. + line + :class:`plotly.graph_objects.waterfall.increasing.marke + r.Line` instance or dict with compatible properties + """ + + def __init__(self, arg=None, color=None, line=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.increasing.Marker` + color + Sets the marker color of all increasing values. + line + :class:`plotly.graph_objects.waterfall.increasing.marke + r.Line` instance or dict with compatible properties + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.increasing.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.increasing.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/_line.py new file mode 100644 index 0000000..5f5b464 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/increasing/marker/_line.py @@ -0,0 +1,104 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.increasing.marker" + _path_str = "waterfall.increasing.marker.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the line color of all increasing values. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the line width of all increasing values. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color of all increasing values. + width + Sets the line width of all increasing values. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.waterfall.incr + easing.marker.Line` + color + Sets the line color of all increasing values. + width + Sets the line width of all increasing values. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.increasing.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.increasing.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/__init__.py new file mode 100644 index 0000000..56f600d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._font import Font +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._font.Font"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/_font.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/_font.py new file mode 100644 index 0000000..6e8055c --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/legendgrouptitle/_font.py @@ -0,0 +1,334 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Font(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.legendgrouptitle" + _path_str = "waterfall.legendgrouptitle.font" + _valid_props = { + "color", + "family", + "lineposition", + "shadow", + "size", + "style", + "textcase", + "variant", + "weight", + } + + @property + def color(self): + """ + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def family(self): + """ + HTML font family - the typeface that will be applied by the web + browser. The web browser can only apply a font if it is + available on the system where it runs. Provide multiple font + families, separated by commas, to indicate the order in which + to apply fonts if they aren't available. + + The 'family' property is a string and must be specified as: + - A non-empty string + + Returns + ------- + str + """ + return self["family"] + + @family.setter + def family(self, val): + self["family"] = val + + @property + def lineposition(self): + """ + Sets the kind of decoration line(s) with text, such as an + "under", "over" or "through" as well as combinations e.g. + "under+over", etc. + + The 'lineposition' property is a flaglist and may be specified + as a string containing: + - Any combination of ['under', 'over', 'through'] joined with '+' characters + (e.g. 'under+over') + OR exactly one of ['none'] (e.g. 'none') + + Returns + ------- + Any + """ + return self["lineposition"] + + @lineposition.setter + def lineposition(self, val): + self["lineposition"] = val + + @property + def shadow(self): + """ + Sets the shape and color of the shadow behind text. "auto" + places minimal shadow and applies contrast text font color. See + https://developer.mozilla.org/en-US/docs/Web/CSS/text-shadow + for additional options. + + The 'shadow' property is a string and must be specified as: + - A string + - A number that will be converted to a string + + Returns + ------- + str + """ + return self["shadow"] + + @shadow.setter + def shadow(self, val): + self["shadow"] = val + + @property + def size(self): + """ + The 'size' property is a number and may be specified as: + - An int or float in the interval [1, inf] + + Returns + ------- + int|float + """ + return self["size"] + + @size.setter + def size(self, val): + self["size"] = val + + @property + def style(self): + """ + Sets whether a font should be styled with a normal or italic + face from its family. + + The 'style' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'italic'] + + Returns + ------- + Any + """ + return self["style"] + + @style.setter + def style(self, val): + self["style"] = val + + @property + def textcase(self): + """ + Sets capitalization of text. It can be used to make text appear + in all-uppercase or all-lowercase, or with each word + capitalized. + + The 'textcase' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'word caps', 'upper', 'lower'] + + Returns + ------- + Any + """ + return self["textcase"] + + @textcase.setter + def textcase(self, val): + self["textcase"] = val + + @property + def variant(self): + """ + Sets the variant of the font. + + The 'variant' property is an enumeration that may be specified as: + - One of the following enumeration values: + ['normal', 'small-caps', 'all-small-caps', + 'all-petite-caps', 'petite-caps', 'unicase'] + + Returns + ------- + Any + """ + return self["variant"] + + @variant.setter + def variant(self, val): + self["variant"] = val + + @property + def weight(self): + """ + Sets the weight (or boldness) of the font. + + The 'weight' property is a integer and may be specified as: + - An int (or float that will be cast to an int) + in the interval [1, 1000] + OR exactly one of ['normal', 'bold'] (e.g. 'bold') + + Returns + ------- + int + """ + return self["weight"] + + @weight.setter + def weight(self, val): + self["weight"] = val + + @property + def _prop_descriptions(self): + return """\ + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + """ + + def __init__( + self, + arg=None, + color=None, + family=None, + lineposition=None, + shadow=None, + size=None, + style=None, + textcase=None, + variant=None, + weight=None, + **kwargs, + ): + """ + Construct a new Font object + + Sets this legend group's title font. + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of :class:`plotly.graph_objs.waterfall.lege + ndgrouptitle.Font` + color + + family + HTML font family - the typeface that will be applied by + the web browser. The web browser can only apply a font + if it is available on the system where it runs. Provide + multiple font families, separated by commas, to + indicate the order in which to apply fonts if they + aren't available. + lineposition + Sets the kind of decoration line(s) with text, such as + an "under", "over" or "through" as well as combinations + e.g. "under+over", etc. + shadow + Sets the shape and color of the shadow behind text. + "auto" places minimal shadow and applies contrast text + font color. See https://developer.mozilla.org/en- + US/docs/Web/CSS/text-shadow for additional options. + size + + style + Sets whether a font should be styled with a normal or + italic face from its family. + textcase + Sets capitalization of text. It can be used to make + text appear in all-uppercase or all-lowercase, or with + each word capitalized. + variant + Sets the variant of the font. + weight + Sets the weight (or boldness) of the font. + + Returns + ------- + Font + """ + super().__init__("font") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.legendgrouptitle.Font +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.legendgrouptitle.Font`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("family", arg, family) + self._set_property("lineposition", arg, lineposition) + self._set_property("shadow", arg, shadow) + self._set_property("size", arg, size) + self._set_property("style", arg, style) + self._set_property("textcase", arg, textcase) + self._set_property("variant", arg, variant) + self._set_property("weight", arg, weight) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/__init__.py new file mode 100644 index 0000000..3ef756b --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/__init__.py @@ -0,0 +1,12 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._marker import Marker + from . import marker +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import( + __name__, [".marker"], ["._marker.Marker"] + ) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/_marker.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/_marker.py new file mode 100644 index 0000000..5cc16b8 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/_marker.py @@ -0,0 +1,110 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Marker(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.totals" + _path_str = "waterfall.totals.marker" + _valid_props = {"color", "line"} + + @property + def color(self): + """ + Sets the marker color of all intermediate sums and total + values. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def line(self): + """ + The 'line' property is an instance of Line + that may be specified as: + - An instance of :class:`plotly.graph_objs.waterfall.totals.marker.Line` + - A dict of string/value properties that will be passed + to the Line constructor + + Returns + ------- + plotly.graph_objs.waterfall.totals.marker.Line + """ + return self["line"] + + @line.setter + def line(self, val): + self["line"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the marker color of all intermediate sums and + total values. + line + :class:`plotly.graph_objects.waterfall.totals.marker.Li + ne` instance or dict with compatible properties + """ + + def __init__(self, arg=None, color=None, line=None, **kwargs): + """ + Construct a new Marker object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.totals.Marker` + color + Sets the marker color of all intermediate sums and + total values. + line + :class:`plotly.graph_objects.waterfall.totals.marker.Li + ne` instance or dict with compatible properties + + Returns + ------- + Marker + """ + super().__init__("marker") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.totals.Marker +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.totals.Marker`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("line", arg, line) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/__init__.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/__init__.py new file mode 100644 index 0000000..33e42c0 --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/__init__.py @@ -0,0 +1,9 @@ +import sys +from typing import TYPE_CHECKING + +if TYPE_CHECKING: + from ._line import Line +else: + from _plotly_utils.importers import relative_import + + __all__, __getattr__, __dir__ = relative_import(__name__, [], ["._line.Line"]) diff --git a/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/_line.py b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/_line.py new file mode 100644 index 0000000..8c1c81d --- /dev/null +++ b/venv/lib/python3.8/site-packages/plotly/graph_objs/waterfall/totals/marker/_line.py @@ -0,0 +1,108 @@ +# --- THIS FILE IS AUTO-GENERATED --- +# Modifications will be overwitten the next time code generation run. + +from plotly.basedatatypes import BaseTraceHierarchyType as _BaseTraceHierarchyType +import copy as _copy + + +class Line(_BaseTraceHierarchyType): + _parent_path_str = "waterfall.totals.marker" + _path_str = "waterfall.totals.marker.line" + _valid_props = {"color", "width"} + + @property + def color(self): + """ + Sets the line color of all intermediate sums and total values. + + The 'color' property is a color and may be specified as: + - A hex string (e.g. '#ff0000') + - An rgb/rgba string (e.g. 'rgb(255,0,0)') + - An hsl/hsla string (e.g. 'hsl(0,100%,50%)') + - An hsv/hsva string (e.g. 'hsv(0,100%,100%)') + - A named CSS color: see https://plotly.com/python/css-colors/ for a list + + Returns + ------- + str + """ + return self["color"] + + @color.setter + def color(self, val): + self["color"] = val + + @property + def width(self): + """ + Sets the line width of all intermediate sums and total values. + + The 'width' property is a number and may be specified as: + - An int or float in the interval [0, inf] + + Returns + ------- + int|float + """ + return self["width"] + + @width.setter + def width(self, val): + self["width"] = val + + @property + def _prop_descriptions(self): + return """\ + color + Sets the line color of all intermediate sums and total + values. + width + Sets the line width of all intermediate sums and total + values. + """ + + def __init__(self, arg=None, color=None, width=None, **kwargs): + """ + Construct a new Line object + + Parameters + ---------- + arg + dict of properties compatible with this constructor or + an instance of + :class:`plotly.graph_objs.waterfall.totals.marker.Line` + color + Sets the line color of all intermediate sums and total + values. + width + Sets the line width of all intermediate sums and total + values. + + Returns + ------- + Line + """ + super().__init__("line") + if "_parent" in kwargs: + self._parent = kwargs["_parent"] + return + + if arg is None: + arg = {} + elif isinstance(arg, self.__class__): + arg = arg.to_plotly_json() + elif isinstance(arg, dict): + arg = _copy.copy(arg) + else: + raise ValueError("""\ +The first argument to the plotly.graph_objs.waterfall.totals.marker.Line +constructor must be a dict or +an instance of :class:`plotly.graph_objs.waterfall.totals.marker.Line`""") + + self._skip_invalid = kwargs.pop("skip_invalid", False) + self._validate = kwargs.pop("_validate", True) + + self._set_property("color", arg, color) + self._set_property("width", arg, width) + self._process_kwargs(**dict(arg, **kwargs)) + self._skip_invalid = False -- cgit v1.2.3-70-g09d2